{
"description": "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.",
"_filename": "gd-HumanName.StructureDefinition-profile.json",
"package_name": "ehelse.fhir.no.grunndata",
"date": "2019-10-18",
"derivation": "constraint",
"publisher": null,
"fhirVersion": "4.0.0",
"name": "GdHumanName",
"abstract": false,
"type": "HumanName",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "2.1.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HumanName",
"min": 0,
"definition": "gd-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).",
"short": "Norwegian human name from FREG",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XPN",
"identity": "v2"
}, {
"map": "EN (actually, PN)",
"identity": "rim"
}, {
"map": "ProviderName",
"identity": "servd"
} ],
"max": "*",
"id": "HumanName",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "HumanName"
}
}, {
"path": "HumanName.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"_code": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:string"
} ]
}
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HumanName.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HumanName.extension",
"min": 0,
"definition": "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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HumanName.extension",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HumanName.extension",
"min": 0,
"definition": "Defines 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).",
"short": "Defines a middle name",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.no/fhir/StructureDefinition/no-basis-middlename" ]
} ],
"mustSupport": true,
"sliceName": "middlename",
"alias": [ "extensions", "user content", "mellomnavn" ],
"max": "1",
"id": "HumanName.extension:middlename",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HumanName.extension",
"min": 0,
"definition": "Registermetadata describes metadata about resources available from the norwegian person index (folkeregisteret), all resources containing metadata from folkeregisteret will include registermetadata",
"short": "Registermetadata",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-fregmetadata" ]
} ],
"sliceName": "fregMetadata",
"alias": [ "extensions", "user content", "registermetadata", "RegistermetadataMedGyldighet" ],
"max": "1",
"id": "HumanName.extension:fregMetadata",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HumanName.extension",
"min": 0,
"definition": "additional metadata about human name defined by FREG (folkeregisterpersonnavn) describes metadata specific to the HumanName available from the norwegian person index (folkeregisteret, freg)",
"short": "additional metadata about human name from FREG",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-additional-humanname" ]
} ],
"sliceName": "fregName",
"alias": [ "extensions", "user content", "folkeregisterpersonnavn", "forkortetnavn", "originaltnavn" ],
"max": "1",
"id": "HumanName.extension:fregName",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HumanName.use",
"requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
"min": 0,
"definition": "gd-HumanName don't use this element
Identifies the purpose for this name.",
"isModifier": true,
"short": "use is not used in Norwegian names",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XPN.7, but often indicated by which field contains the name",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./NamePurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/name-use|4.0.0",
"description": "The use of a human name."
},
"max": "1",
"id": "HumanName.use",
"condition": [ "ele-1" ],
"comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HumanName.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "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.",
"short": "Text representation of the full name",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "implied by XPN.11",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HumanName.text",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HumanName.family",
"min": 0,
"definition": "Ref. \"lov om personnavn\" for further details about Norwegian HumanNames.\r\n\r\nThe 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.",
"short": "Family name (often called 'Surname')",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XPN.1/FN.1",
"identity": "v2"
}, {
"map": "./part[partType = FAM]",
"identity": "rim"
}, {
"map": "./FamilyName",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "surname", "etternavn" ],
"max": "1",
"id": "HumanName.family",
"condition": [ "ele-1" ],
"comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.family"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HumanName.given",
"min": 0,
"definition": "Given 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.",
"short": "Given names (not always 'first')",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XPN.2 + XPN.3",
"identity": "v2"
}, {
"map": "./part[partType = GIV]",
"identity": "rim"
}, {
"map": "./GivenNames",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "first name", "middle name", "fornavn" ],
"max": "1",
"id": "HumanName.given",
"condition": [ "ele-1" ],
"comment": "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.",
"orderMeaning": "Given Names appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.given"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HumanName.prefix",
"min": 0,
"definition": "This is not a part of official Norwegian names as defined in \"lov om personnavn\" regulation.\r\n\r\nPart 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.",
"short": "Prefix is not used in Norwegian names",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XPN.5",
"identity": "v2"
}, {
"map": "./part[partType = PFX]",
"identity": "rim"
}, {
"map": "./TitleCode",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "*",
"id": "HumanName.prefix",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"orderMeaning": "Prefixes appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.prefix"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HumanName.suffix",
"min": 0,
"definition": "This is not a part of official Norwegian names as defined in \"lov om personnavn\" regulation.\r\n\r\nPart 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.",
"short": "Suffix is not used in Norwegian human names",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XPN/4",
"identity": "v2"
}, {
"map": "./part[partType = SFX]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "*",
"id": "HumanName.suffix",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"orderMeaning": "Suffixes appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.suffix"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "per-1",
"human": "If present, start SHALL have a lower value than end",
"xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"source": "Period",
"severity": "error",
"expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)"
} ],
"path": "HumanName.period",
"requirements": "Allows names to be placed in historical context.",
"min": 0,
"definition": "gd-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.",
"short": "Not used",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "DR",
"identity": "v2"
}, {
"map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]",
"identity": "rim"
}, {
"map": "XPN.13 + XPN.14",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": false,
"max": "1",
"id": "HumanName.period",
"condition": [ "ele-1" ],
"comment": "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\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.period"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "b01365ea-d98c-49cf-9145-2492b60644c9",
"kind": "complex-type",
"url": "http://ehelse.no/fhir/StructureDefinition/gd-HumanName",
"version": "2.0.2",
"differential": {
"element": [ {
"id": "HumanName",
"path": "HumanName",
"short": "Norwegian human name from FREG",
"definition": "gd-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)."
}, {
"id": "HumanName.extension:middlename",
"path": "HumanName.extension",
"sliceName": "middlename",
"mustSupport": true
}, {
"id": "HumanName.extension:fregMetadata",
"max": "1",
"min": 0,
"path": "HumanName.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-fregmetadata" ]
} ],
"short": "Registermetadata",
"sliceName": "fregMetadata",
"definition": "Registermetadata describes metadata about resources available from the norwegian person index (folkeregisteret), all resources containing metadata from folkeregisteret will include registermetadata"
}, {
"path": "HumanName.extension",
"min": 0,
"definition": "additional metadata about human name defined by FREG (folkeregisterpersonnavn) describes metadata specific to the HumanName available from the norwegian person index (folkeregisteret, freg)",
"short": "additional metadata about human name from FREG",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-additional-humanname" ]
} ],
"sliceName": "fregName",
"alias": [ "forkortetnavn", "originaltnavn" ],
"max": "1",
"id": "HumanName.extension:fregName"
}, {
"id": "HumanName.use",
"path": "HumanName.use",
"short": "use is not used in Norwegian names",
"definition": "gd-HumanName don't use this element
Identifies the purpose for this name.",
"mustSupport": false
}, {
"id": "HumanName.family",
"path": "HumanName.family",
"mustSupport": true
}, {
"id": "HumanName.given",
"path": "HumanName.given",
"mustSupport": true
}, {
"id": "HumanName.period",
"path": "HumanName.period",
"short": "Not used",
"definition": "gd-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.",
"mustSupport": false
} ]
},
"baseDefinition": "http://hl7.no/fhir/StructureDefinition/no-basis-HumanName"
}