Master Person Index R4

gd-HumanName datatype profile

The GdHumanName profile

Grunndata personnavn. Contains information and metadata for human names defined in Norwegian Master Person Index and Norwegian Directorate of e-Health's health related Master Person Index.

middlenameS0..1Extension(string)
fregMetadata0..1Extension(Complex)
fregName0..1Extension(Complex)
useΣ ?!0..1codeBinding
textΣ0..1string
familyS Σ0..1string
givenS Σ0..1string
prefixΣ0..*string
suffixΣ0..*string
periodΣ0..1Period
HumanName
Definitiongd-HumanName Contains information and metadata for human names defined in Norwegian Master Person Index and Norwegian Directorate of e-Health's health related Master Person Index. Defines the format of norwegian human name according to norwegian regulation (lov om personnavn).
Cardinality0...*
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 might or might 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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XPN
  • rim:EN (actually, PN)
  • servd:ProviderName
HumanName.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Type
Mappings
  • rim:n/a
HumanName.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
HumanName.extension:middlename
DefinitionDefines a middle name as a specific extension as this is widely used in Norwegian names. The middlename is defined in norwegian legislation (lov om personnavn).
Cardinality0...1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content, mellomnavn
Comments

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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
HumanName.extension:fregMetadata
DefinitionRegistermetadata describes metadata about resources available from the norwegian person index (folkeregisteret), all resources containing metadata from folkeregisteret will include registermetadata
Cardinality0...1
TypeExtension(Complex)
Aliasextensions, user content, registermetadata, RegistermetadataMedGyldighet
Comments

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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
HumanName.extension:fregName
Definitionadditional metadata about human name defined by FREG (folkeregisterpersonnavn) describes metadata specific to the HumanName available from the norwegian person index (folkeregisteret, freg)
Cardinality0...1
TypeExtension(Complex)
Aliasextensions, user content, folkeregisterpersonnavn, forkortetnavn, originaltnavn
Comments

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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
HumanName.use
Definitiongd-HumanName don't use this element Identifies the purpose for this name.
Cardinality0...1
Typecode
BindingNameUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XPN.7, but often indicated by which field contains the name
  • rim:unique(./use)
  • servd:./NamePurpose
HumanName.text
DefinitionSpecifies 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.
Cardinality0...1
Typestring
SummaryTrue
Requirements

A renderable, unencoded form.

Comments

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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:implied by XPN.11
  • rim:./formatted
HumanName.family
DefinitionRef. "lov om personnavn" for further details about Norwegian HumanNames. 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.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Aliassurname, etternavn
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XPN.1/FN.1
  • rim:./part[partType = FAM]
  • servd:./FamilyName
HumanName.given
DefinitionGiven name. In Norway Given name does not include middlenames according to the regulation for norwegian names. Multiple given names are however legal. Ref. "Lov om personnavn" for further details about Norwegian HumanNames.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Aliasfirst name, middle name, fornavn
Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XPN.2 + XPN.3
  • rim:./part[partType = GIV]
  • servd:./GivenNames
HumanName.prefix
DefinitionThis is not a part of official Norwegian names as defined in "lov om personnavn" regulation. 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.
Cardinality0...*
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XPN.5
  • rim:./part[partType = PFX]
  • servd:./TitleCode
HumanName.suffix
DefinitionThis is not a part of official Norwegian names as defined in "lov om personnavn" regulation. 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.
Cardinality0...*
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XPN/4
  • rim:./part[partType = SFX]
HumanName.period
Definitiongd-HumanName: will not use this element for metadata about when a HumanName is/was in use. The information will be provided through metadata from the Master Person Index (FREG). Indicates the period of time when this name was valid for the named person.
Cardinality0...1
TypePeriod
SummaryTrue
Requirements

Allows names to be placed in historical context.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1:If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim:n/a
  • v2:DR
  • rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2:XPN.13 + XPN.14
  • rim:./usablePeriod[type="IVL<TS>"]
  • servd:./StartDate and ./EndDate