{
"description": "French profile of datatype HumanName with constraints on prefix and suffix | Profilage du type de données HumanName pour prise en compte de la civilté au niveau de l'élément prefix et du titre au niveau de l'élément suffix",
"_filename": "StructureDefinition-fr-core-human-name.json",
"package_name": "hl7.fhir.fr.core",
"date": "2024-03-25T12:19:18+01:00",
"derivation": "constraint",
"publisher": "Interop'Santé",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "FR",
"system": "urn:iso:std:iso:3166",
"display": "France"
} ]
} ],
"name": "FRCoreHumanNameProfile",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD",
"identity": "servd"
} ],
"abstract": false,
"type": "HumanName",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "FR Core Human Name Profile",
"package_version": "2.0.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HumanName",
"min": 0,
"definition": "A human's name with the ability to identify parts and usage.",
"isModifier": false,
"short": "Name of a human - parts and usage",
"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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HumanName.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/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": "http://hl7.org/fhir/StructureDefinition/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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"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",
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HumanName.extension",
"min": 0,
"definition": "A code that represents the preferred display order of the components of this human name.",
"isModifier": false,
"short": "Preferred display order of name parts",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" ]
} ],
"sliceName": "assemblyOrder",
"max": "1",
"id": "HumanName.extension:assemblyOrder",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/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": "Identifies the purpose for this name.",
"isModifier": true,
"short": "usual | official | temp | nickname | anonymous | old | maiden",
"mapping": [ {
"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",
"valueSet": "http://hl7.org/fhir/ValueSet/name-use"
},
"max": "1",
"id": "HumanName.use",
"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": "http://hl7.org/fhir/StructureDefinition/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.",
"isModifier": false,
"short": "Text representation of the full name",
"mapping": [ {
"map": "implied by XPN.11",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HumanName.text",
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HumanName.family",
"min": 0,
"definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.",
"isModifier": false,
"short": "Family name (often called 'Surname')",
"mapping": [ {
"map": "XPN.1/FN.1",
"identity": "v2"
}, {
"map": "./part[partType = FAM]",
"identity": "rim"
}, {
"map": "./FamilyName",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "surname" ],
"max": "1",
"id": "HumanName.family",
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HumanName.given",
"min": 0,
"definition": "Given name.",
"isModifier": false,
"short": "Given names (not always 'first'). Includes middle names",
"mapping": [ {
"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" ],
"max": "*",
"id": "HumanName.given",
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HumanName.prefix",
"min": 0,
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.",
"isModifier": false,
"short": "Parts that come before the name",
"mapping": [ {
"map": "XPN.5",
"identity": "v2"
}, {
"map": "./part[partType = PFX]",
"identity": "rim"
}, {
"map": "./TitleCode",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"binding": {
"strength": "extensible",
"valueSet": "https://mos.esante.gouv.fr/NOS/JDV_J78-Civilite-RASS/FHIR/JDV-J78-Civilite-RASS",
"description": "Civilités des personnes physiques du RASS"
},
"max": "1",
"id": "HumanName.prefix",
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HumanName.suffix",
"min": 0,
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.",
"isModifier": false,
"short": "jeu de valeurs pour spécifier le titre de la personne",
"mapping": [ {
"map": "XPN/4",
"identity": "v2"
}, {
"map": "./part[partType = SFX]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"binding": {
"strength": "extensible",
"valueSet": "https://mos.esante.gouv.fr/NOS/JDV_J79-CiviliteExercice-RASS/FHIR/JDV-J79-CiviliteExercice-RASS",
"description": "Civilités d'exercice d'un professionnel du RASS"
},
"max": "*",
"id": "HumanName.suffix",
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"short": "Time period when name was/is in use",
"mapping": [ {
"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",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.period"
},
"isSummary": true
} ]
},
"status": "active",
"id": "96cead96-8cef-4523-a289-f5d95a654a55",
"kind": "complex-type",
"url": "https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-human-name",
"version": "2.0.0",
"differential": {
"element": [ {
"id": "HumanName.extension:assemblyOrder",
"max": "1",
"min": 0,
"path": "HumanName.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" ]
} ],
"sliceName": "assemblyOrder"
}, {
"id": "HumanName.use",
"path": "HumanName.use",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/name-use"
}
}, {
"id": "HumanName.prefix",
"max": "1",
"path": "HumanName.prefix",
"binding": {
"strength": "extensible",
"valueSet": "https://mos.esante.gouv.fr/NOS/JDV_J78-Civilite-RASS/FHIR/JDV-J78-Civilite-RASS",
"description": "Civilités des personnes physiques du RASS"
}
}, {
"id": "HumanName.suffix",
"path": "HumanName.suffix",
"short": "jeu de valeurs pour spécifier le titre de la personne",
"binding": {
"strength": "extensible",
"valueSet": "https://mos.esante.gouv.fr/NOS/JDV_J79-CiviliteExercice-RASS/FHIR/JDV-J79-CiviliteExercice-RASS",
"description": "Civilités d'exercice d'un professionnel du RASS"
}
} ]
},
"contact": [ {
"name": "Interop'Santé",
"telecom": [ {
"value": "http://interopsante.org/",
"system": "url"
} ]
}, {
"name": "InteropSanté",
"telecom": [ {
"use": "work",
"value": "fhir@interopsante.org",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/HumanName"
}