{
"description": "Basisprofil for Norwegian HumanName. Defined by The Norwegian Directorate of eHealth and HL7 Norway. The profile adds the concept of middlename and further explains of the use for the data-elements in a Norwegian context. The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.",
"_filename": "no-basis-HumanName.structuredefinition-profile.json",
"package_name": "HL7Norway.STU3.no.basis",
"date": "2018-10-26",
"derivation": "constraint",
"meta": {
"versionId": "1",
"lastUpdated": "2018-06-13T12:22:47.269+00:00"
},
"publisher": null,
"fhirVersion": "3.0.1",
"name": "no-basis-HumanName",
"abstract": false,
"type": "HumanName",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.3",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "HumanName",
"min": 0,
"definition": "Defines the format of norwegian human name according to norwegian regulation (lov om personnavn).",
"short": "Norwegian human name",
"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 may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.",
"base": {
"max": "*",
"min": 0,
"path": "Element"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HumanName.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"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",
"severity": "error",
"expression": "hasValue() | (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')])",
"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. In order 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 is allowed to 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",
"severity": "error",
"expression": "hasValue() | (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')])",
"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 and the given shoul appear before any middle name.",
"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"
} ],
"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",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "HumanName.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HumanName.extension:middlename.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"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",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HumanName.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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:middlename.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",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "HumanName.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.no/fhir/StructureDefinition/no-basis-middlename",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HumanName.extension:middlename.url",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "HumanName.extension.valueString",
"min": 0,
"definition": "The middle name of the person.\r\nThe middlename should be a norwegian middlename as defined by norwegian regulation (Lov om personnavn).",
"short": "The middlename",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"sliceName": "valueString",
"alias": [ "mellomnavn" ],
"max": "1",
"id": "HumanName.extension:middlename.valueString:valueString",
"condition": [ "ele-1" ],
"comment": "A stream of bytes, base64 encoded",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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": "Identifies the purpose for this name.",
"isModifier": true,
"short": "usual | official | temp | nickname | anonymous | old | maiden",
"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"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NameUse"
} ],
"description": "The use of a human name",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/name-use"
}
},
"max": "1",
"id": "HumanName.use",
"condition": [ "ele-1" ],
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.use"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "HumanName.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "A full text representation of the name.",
"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 structured parts.",
"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",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "HumanName.family",
"min": 1,
"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"
} ],
"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",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "HumanName.given",
"min": 1,
"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"
} ],
"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. 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",
"severity": "error",
"expression": "hasValue() | (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 may 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",
"severity": "error",
"expression": "hasValue() | (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 may 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",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "per-1",
"human": "If present, start SHALL have a lower value than end",
"xpath": "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)",
"severity": "error",
"expression": "start.empty() or end.empty() or (start <= end)"
} ],
"path": "HumanName.period",
"requirements": "Allows names to be placed in historical context.",
"min": 0,
"definition": "Indicates the period of time when this name was valid for the named person.",
"short": "Time period when name was/is in use",
"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"
} ],
"max": "1",
"id": "HumanName.period",
"condition": [ "ele-1" ],
"comment": "This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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\"). If duration is required, specify the type as Interval|Duration.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.period"
},
"isSummary": true
} ]
},
"status": "active",
"id": "f2d1ee42-6039-4276-99ed-173fc55ba33b",
"kind": "complex-type",
"url": "http://hl7.no/fhir/StructureDefinition/no-basis-HumanName",
"version": "1.0",
"differential": {
"element": [ {
"id": "HumanName",
"path": "HumanName",
"short": "Norwegian human name",
"definition": "Defines the format of norwegian human name according to norwegian regulation (lov om personnavn)."
}, {
"id": "HumanName.extension",
"path": "HumanName.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "HumanName.extension:middlename",
"path": "HumanName.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.no/fhir/StructureDefinition/no-basis-middlename"
} ],
"short": "Defines a middle name",
"sliceName": "middlename",
"definition": "Defines a middle name as a specific extension as this is widely used in Norwegian names and the given shoul appear before any middle name."
}, {
"id": "HumanName.extension:middlename.valueString:valueString",
"path": "HumanName.extension.valueString",
"sliceName": "valueString",
"definition": "The middle name of the person.\r\nThe middlename should be a norwegian middlename as defined by norwegian regulation (Lov om personnavn)."
}, {
"id": "HumanName.family",
"min": 1,
"path": "HumanName.family",
"alias": [ "etternavn" ],
"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."
}, {
"id": "HumanName.given",
"max": "1",
"min": 1,
"path": "HumanName.given",
"alias": [ "fornavn" ],
"short": "Given names (not always 'first')",
"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."
}, {
"id": "HumanName.prefix",
"path": "HumanName.prefix",
"short": "Prefix is not used in Norwegian names",
"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.",
"mustSupport": false
}, {
"id": "HumanName.suffix",
"path": "HumanName.suffix",
"short": "Suffix is not used in Norwegian human names",
"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.",
"mustSupport": false
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/HumanName"
}