zib-NameInformation
type: StructureDefinition
node role: treeRoot
id:
  v: zib-NameInformation
text:
  status:
    v: extensions
  div: Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> HumanName C 0..* HumanName This is an abstract profile. Child profiles: NlcoreNameInformation NameInformation zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well nameUsage 0..* code Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name. value[x] 1..1 code NameUsage Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder. use 1..1 code usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official family prefix 0..1 string Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix value[x] 1..1 string Prefix lastName 0..1 string Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name value[x] 1..1 string LastName partnerPrefix 0..1 string Voorvoegsel derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix value[x] 1..1 string PartnerPrefix partnerLastName 0..1 string Portion derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name value[x] 1..1 string PartnerLastName given 0..* string FirstName / Initial extension 1..* Extension Extension givenOrInitial 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (…
url:
  v: http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation
version:
  v: 0.9.0
name:
  v: ZibNameInformation
title:
  v: zib NameInformation
status:
  v: draft
date:
  v: 2023-10-17T18:06:34+02:00
publisher:
  v: HL7NL
contact:
  name:
    v: HL7NL
  telecom:
    system:
      v: url
    value:
      v: https://hl7.nl
description:
  v: A person's official name information, including given names, last name and possibly the partner's last name.
purpose:
  v: This HumanName datatype represents the Dutch [zib ('Zorginformatiebouwsteen', i.e. Health and Care Information Model) NameInformation v1.1 (2020)](https://zibs.nl/wiki/NameInformation-v1.1(2020EN)), except for the GivenName concept. For the entire zib, the complementary profile [zib-NameInformation.GivenName](http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation.GivenName) should be used. Both profiles can be added in a slice with the discriminator set to `value`/`use`.
copyright:
  v: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  uri:
    v: https://zibs.nl/wiki/NameInformation-v1.1(2020EN)
  name:
    v: zib NameInformation-v1.1(2020EN)
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
  name:
    v: HL7 v2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: servd
  uri:
    v: http://www.omg.org/spec/ServD/1.0/
  name:
    v: ServD
kind:
  v: complex-type
abstract:
  v: true
type:
  v: HumanName
base definition:
  v: http://hl7.org/fhir/StructureDefinition/HumanName
  link: http://hl7.org/fhir/StructureDefinition/HumanName
derivation:
  v: constraint
snapshot:
  element:
    id:
      v: HumanName
    path:
      v: HumanName
    short:
      v: NameInformation
    definition:
      v: This slice represents the person's official name information, including given names, last name and possibly the partner's last name.
    comment:
      v: This `.name` element represents a Dutch name according to the [zib NameInformation (v1.1, 2020)](https://zibs.nl/wiki/NameInformation-v1.1(2020EN)) (except for the GivenName concept). A Dutch name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Dutch rules. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Dutch context SHOULD support these extensions as specified here. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. It is encouraged to provide a representation of the full name in the `.text` element. **Note 1**: The zib cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept. **Note 2**: This element should only contain a person's _official_ names. The GivenName concept is represented in another `.name` element with `.name.use` = _usual_. **Note 3**: The examples illustrate how the zib is mapped to FHIR.
    alias:
      v: Naamgegevens
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: HumanName
      min:
        v: 0
      max:
        v: *
    condition:
      v: ele-1
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        link: http://hl7.org/fhir/StructureDefinition/Element
    constraint:
      key:
        v: zib-NameInformation-1
      severity:
        v: error
      human:
        v: If a prefix for a family name is specified, the family name is expected as well
      expression:
        v: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
    constraint:
      key:
        v: zib-NameInformation-2
      severity:
        v: error
      human:
        v: If the prefix for a partner family name is specified, the partner family name is expected as well
      expression:
        v: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
    mapping:
      identity:
        v: v2
      map:
        v: XPN
    mapping:
      identity:
        v: rim
      map:
        v: EN (actually, PN)
    mapping:
      identity:
        v: servd
      map:
        v: ProviderName
    mapping:
      identity:
        v: zib-nameinformation-v1.1-2020EN
      map:
        v: NL-CM:20.4.1
      comment:
        v: NameInformation
  element:
    id:
      v: HumanName.id
    path:
      v: HumanName.id
    representation:
      v: xmlAttr
    short:
      v: Unique id for inter-element referencing
    definition:
      v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Element.id
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: http://hl7.org/fhirpath/System.String
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: HumanName.extension

v: string

v: HumanName.extension

discriminator:
  type:
    v: value
  path:
    v: url
description:
  v: Extensions are always sliced by (at least) url
rules:
  v: open

v: Additional content defined by implementations

v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

v: extensions

v: user content

v: 0

v: *

path:
  v: Element.extension
min:
  v: 0
max:
  v: *

code:
  v: Extension

key:
  v: ele-1
severity:
  v: error
human:
  v: All FHIR elements must have a @value or children
expression:
  v: hasValue() or (children().count() > id.count())
xpath:
  v: @value|f:*|h:div
source:
  v: http://hl7.org/fhir/StructureDefinition/Element
  link: http://hl7.org/fhir/StructureDefinition/Element

key:
  v: ext-1
severity:
  v: error
human:
  v: Must have either extensions or value[x], not both
expression:
  v: extension.exists() != value.exists()
xpath:
  v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
source:
  v: http://hl7.org/fhir/StructureDefinition/Extension
  link: http://hl7.org/fhir/StructureDefinition/Extension

v: false

v: false

identity:
  v: rim
map:
  v: n/a

id:
  v: HumanName.extension:nameUsage
path:
  v: HumanName.extension
slice name:
  v: nameUsage
short:
  v: Preferred display order of name parts
definition:
  v: A code that represents the preferred display order of the components of this human name.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
    link: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: HumanName.extension:nameUsage.id
path:
  v: HumanName.extension.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: HumanName.extension:nameUsage.extension
path:
  v: HumanName.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: HumanName.extension:nameUsage.url
path:
  v: HumanName.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed:
  v: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: HumanName.extension:nameUsage.value[x]
path:
  v: HumanName.extension.value[x]
short:
  v: NameUsage
definition:
  v: This concept indicates the last name or order of last names with which the person is to be addressed.
alias:
  v: Naamgebruik
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  strength:
    v: required
  description:
    v: Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
  value set:
    v: http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.7
  comment:
    v: NameUsage

id:
  v: HumanName.use
path:
  v: HumanName.use
short:
  v: usual | official | temp | nickname | anonymous | old | maiden
definition:
  v: Identifies the purpose for this name.
comment:
  v: Applications can assume that a name is current unless it explicitly says that it is temporary or old.
requirements:
  v: Allows the appropriate name for a particular context of use to be selected from among a set of names.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HumanName.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
pattern:
  v: official
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: NameUse
  strength:
    v: required
  description:
    v: The use of a human name.
  value set:
    v: http://hl7.org/fhir/ValueSet/name-use|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: XPN.7, but often indicated by which field contains the name
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./NamePurpose

id:
  v: HumanName.text
path:
  v: HumanName.text
short:
  v: Text representation of the full name
definition:
  v: Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
comment:
  v: Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
requirements:
  v: A renderable, unencoded form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: implied by XPN.11
mapping:
  identity:
    v: rim
  map:
    v: ./formatted

id:
  v: HumanName.family
path:
  v: HumanName.family
short:
  v: Family name (often called 'Surname')
definition:
  v: 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.
comment:
  v: Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
alias:
  v: surname
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.family
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.1/FN.1
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = FAM]
mapping:
  identity:
    v: servd
  map:
    v: ./FamilyName

id:
  v: HumanName.family.id
path:
  v: HumanName.family.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false

id:
  v: HumanName.family.extension
path:
  v: HumanName.family.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: HumanName.family.extension:prefix
path:
  v: HumanName.family.extension
slice name:
  v: prefix
short:
  v: Voorvoegsel derived from person's own surname
definition:
  v: The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.
comment:
  v: An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
    link: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: FN.2
mapping:
  identity:
    v: rim
  map:
    v: ENXP where Qualifiers = (VV, R)

id:
  v: HumanName.family.extension:prefix.id
path:
  v: HumanName.family.extension.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: HumanName.family.extension:prefix.extension
path:
  v: HumanName.family.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: HumanName.family.extension:prefix.url
path:
  v: HumanName.family.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed:
  v: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: HumanName.family.extension:prefix.value[x]
path:
  v: HumanName.family.extension.value[x]
short:
  v: Prefix
definition:
  v: Prefix to the person’s own last name.
alias:
  v: Voorvoegsels
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.11
  comment:
    v: Prefix

id:
  v: HumanName.family.extension:lastName
path:
  v: HumanName.family.extension
slice name:
  v: lastName
short:
  v: Portion derived from person's own surname
definition:
  v: The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.
comment:
  v: If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-own-name
    link: http://hl7.org/fhir/StructureDefinition/humanname-own-name
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: FN.3
mapping:
  identity:
    v: rim
  map:
    v: ENXP where Qualifiers = (BR)

id:
  v: HumanName.family.extension:lastName.id
path:
  v: HumanName.family.extension.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: HumanName.family.extension:lastName.extension
path:
  v: HumanName.family.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: HumanName.family.extension:lastName.url
path:
  v: HumanName.family.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed:
  v: http://hl7.org/fhir/StructureDefinition/humanname-own-name
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: HumanName.family.extension:lastName.value[x]
path:
  v: HumanName.family.extension.value[x]
short:
  v: LastName
definition:
  v: The person’s official last name
alias:
  v: Achternaam
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.10
  comment:
    v: LastName

id:
  v: HumanName.family.extension:partnerPrefix
path:
  v: HumanName.family.extension
slice name:
  v: partnerPrefix
short:
  v: Voorvoegsel derived from person's partner's surname
definition:
  v: The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own.
comment:
  v: An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
    link: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: FN.4
mapping:
  identity:
    v: rim
  map:
    v: ENXP where Qualifiers = (VV, SP)

id:
  v: HumanName.family.extension:partnerPrefix.id
path:
  v: HumanName.family.extension.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: HumanName.family.extension:partnerPrefix.extension
path:
  v: HumanName.family.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: HumanName.family.extension:partnerPrefix.url
path:
  v: HumanName.family.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed:
  v: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: HumanName.family.extension:partnerPrefix.value[x]
path:
  v: HumanName.family.extension.value[x]
short:
  v: PartnerPrefix
definition:
  v: Prefix to the partner’s last name.
alias:
  v: VoorvoegselsPartner
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.9
  comment:
    v: PartnerPrefix

id:
  v: HumanName.family.extension:partnerLastName
path:
  v: HumanName.family.extension
slice name:
  v: partnerLastName
short:
  v: Portion derived from person's partner's surname
definition:
  v: The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name.
comment:
  v: If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
    link: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: FN.5
mapping:
  identity:
    v: rim
  map:
    v: ENXP where Qualifiers = (SP)

id:
  v: HumanName.family.extension:partnerLastName.id
path:
  v: HumanName.family.extension.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: HumanName.family.extension:partnerLastName.extension
path:
  v: HumanName.family.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: HumanName.family.extension:partnerLastName.url
path:
  v: HumanName.family.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed:
  v: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: HumanName.family.extension:partnerLastName.value[x]
path:
  v: HumanName.family.extension.value[x]
short:
  v: PartnerLastName
definition:
  v: Partner’s official last name.
alias:
  v: AchternaamPartner
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.8
  comment:
    v: PartnerLastName

id:
  v: HumanName.family.value
path:
  v: HumanName.family.value
representation:
  v: xmlAttr
short:
  v: Primitive value for string
definition:
  v: The actual value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: string.value
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/regex
    value:
      v: [ \r\n\t\S]+
  code:
    v: http://hl7.org/fhirpath/System.String
max length:
  v: 1048576
is modifier:
  v: false
is summary:
  v: false

id:
  v: HumanName.given
path:
  v: HumanName.given
short:
  v: FirstName / Initial
definition:
  v: One of a person’s official first names or the initial if the full name is not known.
comment:
  v: This element represents the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately. Therefore, the zib concepts are implemented here in the following way: * Systems SHOULD use a `.given` element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR). * Each of these elements: * SHOULD be populated with the complete name if it is known, or with the initial if no more information is available. * SHALL be augmented with `extension:givenOrInitial` with code _BR_ when it represents a full name or code _IN_ when it represents an initial. Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed. If a system _does_ however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional `.name` instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance. **Note 1:** The GivenName concept should not be included here but in a separate `.name` instance where `.use` = _usual_. **Note 2**: As specified by FHIR, multiple official first names MAY be combined in a single `.given` element (separated by spaces), as long as the `.given` elements can be concatenated to for…
alias:
  v: first name
alias:
  v: middle name
alias:
  v: Voornaam
alias:
  v: Initiaal
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.given
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
order meaning:
  v: Given Names appear in the correct order for presenting the name
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.2 + XPN.3
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = GIV]
mapping:
  identity:
    v: servd
  map:
    v: ./GivenNames
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.4
  comment:
    v: FirstNames
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.5
  comment:
    v: Initials

id:
  v: HumanName.given.id
path:
  v: HumanName.given.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false

id:
  v: HumanName.given.extension
path:
  v: HumanName.given.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 1
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: HumanName.given.extension:givenOrInitial
path:
  v: HumanName.given.extension
slice name:
  v: givenOrInitial
short:
  v: LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
definition:
  v: A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.
comment:
  v: Used to indicate additional information about the name part and how it should be used.
min:
  v: 1
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
    link: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: ENXP.qualifier

id:
  v: HumanName.given.value
path:
  v: HumanName.given.value
representation:
  v: xmlAttr
short:
  v: Primitive value for string
definition:
  v: The actual value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: string.value
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/regex
    value:
      v: [ \r\n\t\S]+
  code:
    v: http://hl7.org/fhirpath/System.String
max length:
  v: 1048576
is modifier:
  v: false
is summary:
  v: false

id:
  v: HumanName.prefix
path:
  v: HumanName.prefix
short:
  v: Titles
definition:
  v: Noble and scientific titles. These can assist in formulating oral and formal addresing titles.
comment:
  v: The zib concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the zib uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. **Export:** Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier _HON_ to indicate honorific prefixes and _AC_ for academic prefixes. If it is not possible to breakup the zib concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. **Import:** Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.
alias:
  v: Titels
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.prefix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
order meaning:
  v: Prefixes appear in the correct order for presenting the name
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.5
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = PFX]
mapping:
  identity:
    v: servd
  map:
    v: ./TitleCode
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.12
  comment:
    v: Titles

id:
  v: HumanName.suffix
path:
  v: HumanName.suffix
short:
  v: Titles
definition:
  v: Noble and scientific titles. These can assist in formulating oral and formal addresing titles.
comment:
  v: The zib concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the zib uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. **Export:** Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier _HON_ to indicate honorific prefixes and _AC_ for academic prefixes. If it is not possible to breakup the zib concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. **Import:** Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.
alias:
  v: Titels
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.suffix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
order meaning:
  v: Suffixes appear in the correct order for presenting the name
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN/4
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = SFX]
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.12
  comment:
    v: Titles

id:
  v: HumanName.period
path:
  v: HumanName.period
short:
  v: Time period when name was/is in use
definition:
  v: Indicates the period of time when this name was valid for the named person.
requirements:
  v: Allows names to be placed in historical context.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.13 + XPN.14
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

element:
  id:
    v: HumanName
  path:
    v: HumanName
  short:
    v: NameInformation
  definition:
    v: This slice represents the person's official name information, including given names, last name and possibly the partner's last name.
  comment:
    v: This `.name` element represents a Dutch name according to the [zib NameInformation (v1.1, 2020)](https://zibs.nl/wiki/NameInformation-v1.1(2020EN)) (except for the GivenName concept). A Dutch name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Dutch rules. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Dutch context SHOULD support these extensions as specified here. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. It is encouraged to provide a representation of the full name in the `.text` element. **Note 1**: The zib cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept. **Note 2**: This element should only contain a person's _official_ names. The GivenName concept is represented in another `.name` element with `.name.use` = _usual_. **Note 3**: The examples illustrate how the zib is mapped to FHIR.
  alias:
    v: Naamgegevens
  constraint:
    key:
      v: zib-NameInformation-1
    severity:
      v: error
    human:
      v: If a prefix for a family name is specified, the family name is expected as well
    expression:
      v: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
  constraint:
    key:
      v: zib-NameInformation-2
    severity:
      v: error
    human:
      v: If the prefix for a partner family name is specified, the partner family name is expected as well
    expression:
      v: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
  mapping:
    identity:
      v: zib-nameinformation-v1.1-2020EN
    map:
      v: NL-CM:20.4.1
    comment:
      v: NameInformation
element:
  id:
    v: HumanName.extension:nameUsage
  path:
    v: HumanName.extension
  slice name:
    v: nameUsage
  type:
    code:
      v: Extension
    profile:
      v: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
      link: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
element:
  id:
    v: HumanName.extension:nameUsage.value[x]
  path:
    v: HumanName.extension.value[x]
  short:
    v: NameUsage
  definition:
    v: This concept indicates the last name or order of last names with which the person is to be addressed.
  alias:
    v: Naamgebruik
  binding:
    strength:
      v: required
    description:
      v: Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
    value set:
      v: http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1
      link: 4.0
      link: .1
  mapping:
    identity:
      v: zib-nameinformation-v1.1-2020EN
    map:
      v: NL-CM:20.4.7
    comment:
      v: NameUsage
element:
  id:
    v: HumanName.use
  path:
    v: HumanName.use
  min:
    v: 1
  pattern:
    v: official
element:
  id:
    v: HumanName.family.extension:prefix
  path:
    v: HumanName.family.extension
  slice name:
    v: prefix
  type:
    code:
      v: Extension
    profile:
      v: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
      link: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
element:
  id:
    v: HumanName.family.extension:prefix.value[x]
  path:
    v: HumanName.family.extension.value[x]
  short:
    v: Prefix
  definition:
    v: Prefix to the person’s own last name.
  alias:
    v: Voorvoegsels
  mapping:
    identity:
      v: zib-nameinformation-v1.1-2020EN
    map:
      v: NL-CM:20.4.11
    comment:
      v: Prefix
element:
  id:
    v: HumanName.family.extension:lastName
  path:
    v: HumanName.family.extension
  slice name:
    v: lastName
  type:
    code:
      v: Extension
    profile:
      v: http://hl7.org/fhir/StructureDefinition/humanname-own-name
      link: http://hl7.org/fhir/StructureDefinition/humanname-own-name
element:
  id:
    v: HumanName.family.extension:lastName.value[x]
  path:
    v: HumanName.family.extension.value[x]
  short:
    v: LastName
  definition:
    v: The person’s official last name
  alias:
    v: Achternaam
  mapping:
    identity:
      v: zib-nameinformation-v1.1-2020EN
    map:
      v: NL-CM:20.4.10
    comment:
      v: LastName
element:
  id:
    v: HumanName.family.extension:partnerPrefix
  path:
    v: HumanName.family.extension
  slice name:
    v: partnerPrefix
  type:
    code:
      v: Extension
    profile:
      v: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
      link: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
element:
  id:
    v: HumanName.family.extension:partnerPrefix.value[x]
  path:
    v: HumanName.family.extension.value[x]
  short:
    v: PartnerPrefix
  definition:
    v: Prefix to the partner’s last name.
  alias:
    v: VoorvoegselsPartner
  mapping:
    identity:
      v: zib-nameinformation-v1.1-2020EN
    map:
      v: NL-CM:20.4.9
    comment:
      v: PartnerPrefix
element:
  id:
    v: HumanName.family.extension:partnerLastName
  path:
    v: HumanName.family.extension
  slice name:
    v: partnerLastName
  type:
    code:
      v: Extension
    profile:
      v: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
      link: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
element:
  id:
    v: HumanName.family.extension:partnerLastName.value[x]
  path:
    v: HumanName.family.extension.value[x]
  short:
    v: PartnerLastName
  definition:
    v: Partner’s official last name.

v: AchternaamPartner

identity:
  v: zib-nameinformation-v1.1-2020EN
map:
  v: NL-CM:20.4.8
comment:
  v: PartnerLastName

id:
  v: HumanName.given
path:
  v: HumanName.given
short:
  v: FirstName / Initial
definition:
  v: One of a person’s official first names or the initial if the full name is not known.
comment:
  v: This element represents the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately. Therefore, the zib concepts are implemented here in the following way: * Systems SHOULD use a `.given` element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR). * Each of these elements: * SHOULD be populated with the complete name if it is known, or with the initial if no more information is available. * SHALL be augmented with `extension:givenOrInitial` with code _BR_ when it represents a full name or code _IN_ when it represents an initial. Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed. If a system _does_ however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional `.name` instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance. **Note 1:** The GivenName concept should not be included here but in a separate `.name` instance where `.use` = _usual_. **Note 2**: As specified by FHIR, multiple official first names MAY be combined in a single `.given` element (separated by spaces), as long as the `.given` elements can be concatenated to for…
alias:
  v: Voornaam
alias:
  v: Initiaal
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.4
  comment:
    v: FirstNames
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.5
  comment:
    v: Initials

id:
  v: HumanName.given.extension
path:
  v: HumanName.given.extension
min:
  v: 1

id:
  v: HumanName.given.extension:givenOrInitial
path:
  v: HumanName.given.extension
slice name:
  v: givenOrInitial
min:
  v: 1
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
    link: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier

id:
  v: HumanName.prefix
path:
  v: HumanName.prefix
short:
  v: Titles
definition:
  v: Noble and scientific titles. These can assist in formulating oral and formal addresing titles.
comment:
  v: The zib concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the zib uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. **Export:** Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier _HON_ to indicate honorific prefixes and _AC_ for academic prefixes. If it is not possible to breakup the zib concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. **Import:** Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.
alias:
  v: Titels
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.12
  comment:
    v: Titles

id:
  v: HumanName.suffix
path:
  v: HumanName.suffix
short:
  v: Titles
definition:
  v: Noble and scientific titles. These can assist in formulating oral and formal addresing titles.
comment:
  v: The zib concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the zib uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. **Export:** Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier _HON_ to indicate honorific prefixes and _AC_ for academic prefixes. If it is not possible to breakup the zib concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. **Import:** Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.
alias:
  v: Titels
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.12
  comment:
    v: Titles