HdBe-NameInformation
Profile | Description | Status | URL |
---|---|---|---|
HdBe-NameInformation | A person's official name information, including given names, last name and possibly the partner's last name. | draft | https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation |
HdBe-NameInformation
Instructions |
---|
This Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on Note 2: This element should only contain a person's official names. The GivenName concept is represented in another Note 3: The examples illustrate how the CBB is mapped to FHIR. |
HumanName | I | HumanName | Element idHumanName NameInformation Alternate namesNaamgegevens DefinitionThis slice represents the person's official name information, including given names, last name and possibly the partner's last name. This Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on Note 2: This element should only contain a person's official names. The GivenName concept is represented in another Note 3: The examples illustrate how the CBB is mapped to FHIR.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idHumanName.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
nameUsage | I | 0..1 | Extension(code) | Element idHumanName.extension:nameUsage Preferred display order of name parts Alternate namesextensions, user content DefinitionA code that represents the preferred display order of the components of this human name. 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. http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.extension:nameUsage.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.extension:nameUsage.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.extension:nameUsage.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
| |
value[x] | 1..1 | Binding | Element idHumanName.extension:nameUsage.value[x] NameUsage Alternate namesNaamgebruik DefinitionThis concept indicates the last name or order of last names with which the person is to be addressed. Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder Permitted Values NameUsage_to_HumanNameAssemblyOrder Constraints
| |
valueCode | code | There are no (further) constraints on this element Data type | ||
use | Σ ?! | 1..1 | codeBindingPattern | Element idHumanName.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
official
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idHumanName.text Text representation of the full name 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. A renderable, unencoded form. 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.
|
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idHumanName.family.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
prefix | I | 0..1 | Extension(string) | Element idHumanName.family.extension:prefix Voorvoegsel derived from person's own surname Alternate namesextensions, user content DefinitionThe 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. 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. http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.extension:prefix.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.family.extension:prefix.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.family.extension:prefix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
| |
value[x] | 1..1 | Element idHumanName.family.extension:prefix.value[x] Prefix Alternate namesVoorvoegsels DefinitionPrefix to the person’s own last name.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
lastName | I | 0..1 | Extension(string) | Element idHumanName.family.extension:lastName Portion derived from person's own surname Alternate namesextensions, user content DefinitionThe 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. 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". http://hl7.org/fhir/StructureDefinition/humanname-own-name Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.extension:lastName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.family.extension:lastName.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.family.extension:lastName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-own-name
| |
value[x] | 1..1 | Element idHumanName.family.extension:lastName.value[x] LastName Alternate namesAchternaam DefinitionThe person’s official last name
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
partnerPrefix | I | 0..1 | Extension(string) | Element idHumanName.family.extension:partnerPrefix Voorvoegsel derived from person's partner's surname Alternate namesextensions, user content DefinitionThe 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. 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. http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.extension:partnerPrefix.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.family.extension:partnerPrefix.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.family.extension:partnerPrefix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
| |
value[x] | 1..1 | Element idHumanName.family.extension:partnerPrefix.value[x] PartnerPrefix Alternate namesVoorvoegselsPartner DefinitionPrefix to the partner’s last name.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
partnerLastName | I | 0..1 | Extension(string) | Element idHumanName.family.extension:partnerLastName Portion derived from person's partner's surname Alternate namesextensions, user content DefinitionThe 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. 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". http://hl7.org/fhir/StructureDefinition/humanname-partner-name Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.extension:partnerLastName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.family.extension:partnerLastName.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.family.extension:partnerLastName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-partner-name
| |
value[x] | 1..1 | Element idHumanName.family.extension:partnerLastName.value[x] PartnerLastName Alternate namesAchternaamPartner DefinitionPartner’s official last name.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
value | 0..1 | System.String | There are no (further) constraints on this element Element idHumanName.family.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |
given | Σ | 0..* | string | Element idHumanName.given FirstName / Initial Alternate namesfirst name, middle name, Voornaam, Initiaal DefinitionOne of a person’s official first names or the initial if the full name is not known. 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:
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 Note 1: The GivenName concept should not be included here but in a separate Note 2: As specified by FHIR, multiple official first names MAY be combined in a single
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.given.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 1..* | Extension | There are no (further) constraints on this element Element idHumanName.given.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
givenOrInitial | I | 1..* | Extension(code) | Element idHumanName.given.extension:givenOrInitial LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV Alternate namesextensions, user content DefinitionA set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Used to indicate additional information about the name part and how it should be used. http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints
|
value | 0..1 | System.String | There are no (further) constraints on this element Element idHumanName.given.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |
prefix | Σ | 0..* | string | Element idHumanName.prefix Titles Alternate namesTitels DefinitionNoble and scientific titles. These can assist in formulating oral and formal addresing titles. The CBB concept 'titles' is mapped to elements 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 CBB 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.
|
suffix | Σ | 0..* | string | Element idHumanName.suffix Titles Alternate namesTitels DefinitionNoble and scientific titles. These can assist in formulating oral and formal addresing titles. The CBB concept 'titles' is mapped to elements 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 CBB 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.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idHumanName.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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.
|
HumanName | I | HumanName | Element idHumanName NameInformation Alternate namesNaamgegevens DefinitionThis slice represents the person's official name information, including given names, last name and possibly the partner's last name. This Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on Note 2: This element should only contain a person's official names. The GivenName concept is represented in another Note 3: The examples illustrate how the CBB is mapped to FHIR.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idHumanName.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
nameUsage | I | 0..1 | Extension(code) | Element idHumanName.extension:nameUsage Preferred display order of name parts Alternate namesextensions, user content DefinitionA code that represents the preferred display order of the components of this human name. 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. http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.extension:nameUsage.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.extension:nameUsage.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.extension:nameUsage.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
| |
value[x] | 1..1 | Binding | Element idHumanName.extension:nameUsage.value[x] NameUsage Alternate namesNaamgebruik DefinitionThis concept indicates the last name or order of last names with which the person is to be addressed. Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder Permitted Values NameUsage_to_HumanNameAssemblyOrder Constraints
| |
valueCode | code | There are no (further) constraints on this element Data type | ||
use | Σ ?! | 1..1 | codeBindingPattern | Element idHumanName.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
official
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idHumanName.text Text representation of the full name 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. A renderable, unencoded form. 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.
|
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idHumanName.family.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
prefix | I | 0..1 | Extension(string) | Element idHumanName.family.extension:prefix Voorvoegsel derived from person's own surname Alternate namesextensions, user content DefinitionThe 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. 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. http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.extension:prefix.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.family.extension:prefix.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.family.extension:prefix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
| |
value[x] | 1..1 | Element idHumanName.family.extension:prefix.value[x] Prefix Alternate namesVoorvoegsels DefinitionPrefix to the person’s own last name.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
lastName | I | 0..1 | Extension(string) | Element idHumanName.family.extension:lastName Portion derived from person's own surname Alternate namesextensions, user content DefinitionThe 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. 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". http://hl7.org/fhir/StructureDefinition/humanname-own-name Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.extension:lastName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.family.extension:lastName.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.family.extension:lastName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-own-name
| |
value[x] | 1..1 | Element idHumanName.family.extension:lastName.value[x] LastName Alternate namesAchternaam DefinitionThe person’s official last name
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
partnerPrefix | I | 0..1 | Extension(string) | Element idHumanName.family.extension:partnerPrefix Voorvoegsel derived from person's partner's surname Alternate namesextensions, user content DefinitionThe 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. 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. http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.extension:partnerPrefix.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.family.extension:partnerPrefix.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.family.extension:partnerPrefix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
| |
value[x] | 1..1 | Element idHumanName.family.extension:partnerPrefix.value[x] PartnerPrefix Alternate namesVoorvoegselsPartner DefinitionPrefix to the partner’s last name.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
partnerLastName | I | 0..1 | Extension(string) | Element idHumanName.family.extension:partnerLastName Portion derived from person's partner's surname Alternate namesextensions, user content DefinitionThe 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. 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". http://hl7.org/fhir/StructureDefinition/humanname-partner-name Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.extension:partnerLastName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.family.extension:partnerLastName.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.family.extension:partnerLastName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-partner-name
| |
value[x] | 1..1 | Element idHumanName.family.extension:partnerLastName.value[x] PartnerLastName Alternate namesAchternaamPartner DefinitionPartner’s official last name.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
value | 0..1 | System.String | There are no (further) constraints on this element Element idHumanName.family.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |
given | Σ | 0..* | string | Element idHumanName.given FirstName / Initial Alternate namesfirst name, middle name, Voornaam, Initiaal DefinitionOne of a person’s official first names or the initial if the full name is not known. 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:
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 Note 1: The GivenName concept should not be included here but in a separate Note 2: As specified by FHIR, multiple official first names MAY be combined in a single
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.given.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 1..* | Extension | There are no (further) constraints on this element Element idHumanName.given.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
givenOrInitial | I | 1..* | Extension(code) | Element idHumanName.given.extension:givenOrInitial LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV Alternate namesextensions, user content DefinitionA set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Used to indicate additional information about the name part and how it should be used. http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints
|
value | 0..1 | System.String | There are no (further) constraints on this element Element idHumanName.given.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |
prefix | Σ | 0..* | string | Element idHumanName.prefix Titles Alternate namesTitels DefinitionNoble and scientific titles. These can assist in formulating oral and formal addresing titles. The CBB concept 'titles' is mapped to elements 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 CBB 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.
|
suffix | Σ | 0..* | string | Element idHumanName.suffix Titles Alternate namesTitels DefinitionNoble and scientific titles. These can assist in formulating oral and formal addresing titles. The CBB concept 'titles' is mapped to elements 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 CBB 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.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idHumanName.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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.
|
HumanName | I | HumanName | Element idHumanName NameInformation Alternate namesNaamgegevens DefinitionThis slice represents the person's official name information, including given names, last name and possibly the partner's last name. This Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on Note 2: This element should only contain a person's official names. The GivenName concept is represented in another Note 3: The examples illustrate how the CBB is mapped to FHIR.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idHumanName.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
nameUsage | I | 0..1 | Extension(code) | Element idHumanName.extension:nameUsage Preferred display order of name parts Alternate namesextensions, user content DefinitionA code that represents the preferred display order of the components of this human name. 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. http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.extension:nameUsage.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.extension:nameUsage.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.extension:nameUsage.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
| |
value[x] | 1..1 | Binding | Element idHumanName.extension:nameUsage.value[x] NameUsage Alternate namesNaamgebruik DefinitionThis concept indicates the last name or order of last names with which the person is to be addressed. Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder Permitted Values NameUsage_to_HumanNameAssemblyOrder Constraints
| |
valueCode | code | There are no (further) constraints on this element Data type | ||
use | Σ ?! | 1..1 | codeBindingPattern | Element idHumanName.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
official
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idHumanName.text Text representation of the full name 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. A renderable, unencoded form. 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.
|
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idHumanName.family.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
prefix | I | 0..1 | Extension(string) | Element idHumanName.family.extension:prefix Voorvoegsel derived from person's own surname Alternate namesextensions, user content DefinitionThe 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. 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. http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.extension:prefix.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.family.extension:prefix.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.family.extension:prefix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
| |
value[x] | 1..1 | Element idHumanName.family.extension:prefix.value[x] Prefix Alternate namesVoorvoegsels DefinitionPrefix to the person’s own last name.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
lastName | I | 0..1 | Extension(string) | Element idHumanName.family.extension:lastName Portion derived from person's own surname Alternate namesextensions, user content DefinitionThe 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. 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". http://hl7.org/fhir/StructureDefinition/humanname-own-name Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.extension:lastName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.family.extension:lastName.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.family.extension:lastName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-own-name
| |
value[x] | 1..1 | Element idHumanName.family.extension:lastName.value[x] LastName Alternate namesAchternaam DefinitionThe person’s official last name
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
partnerPrefix | I | 0..1 | Extension(string) | Element idHumanName.family.extension:partnerPrefix Voorvoegsel derived from person's partner's surname Alternate namesextensions, user content DefinitionThe 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. 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. http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.extension:partnerPrefix.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.family.extension:partnerPrefix.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.family.extension:partnerPrefix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
| |
value[x] | 1..1 | Element idHumanName.family.extension:partnerPrefix.value[x] PartnerPrefix Alternate namesVoorvoegselsPartner DefinitionPrefix to the partner’s last name.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
partnerLastName | I | 0..1 | Extension(string) | Element idHumanName.family.extension:partnerLastName Portion derived from person's partner's surname Alternate namesextensions, user content DefinitionThe 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. 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". http://hl7.org/fhir/StructureDefinition/humanname-partner-name Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.family.extension:partnerLastName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idHumanName.family.extension:partnerLastName.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idHumanName.family.extension:partnerLastName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/StructureDefinition/humanname-partner-name
| |
value[x] | 1..1 | Element idHumanName.family.extension:partnerLastName.value[x] PartnerLastName Alternate namesAchternaamPartner DefinitionPartner’s official last name.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
value | 0..1 | System.String | There are no (further) constraints on this element Element idHumanName.family.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |
given | Σ | 0..* | string | Element idHumanName.given FirstName / Initial Alternate namesfirst name, middle name, Voornaam, Initiaal DefinitionOne of a person’s official first names or the initial if the full name is not known. 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:
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 Note 1: The GivenName concept should not be included here but in a separate Note 2: As specified by FHIR, multiple official first names MAY be combined in a single
|
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.given.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 1..* | Extension | There are no (further) constraints on this element Element idHumanName.given.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
givenOrInitial | I | 1..* | Extension(code) | Element idHumanName.given.extension:givenOrInitial LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV Alternate namesextensions, user content DefinitionA set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Used to indicate additional information about the name part and how it should be used. http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints
|
value | 0..1 | System.String | There are no (further) constraints on this element Element idHumanName.given.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |
prefix | Σ | 0..* | string | Element idHumanName.prefix Titles Alternate namesTitels DefinitionNoble and scientific titles. These can assist in formulating oral and formal addresing titles. The CBB concept 'titles' is mapped to elements 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 CBB 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.
|
suffix | Σ | 0..* | string | Element idHumanName.suffix Titles Alternate namesTitels DefinitionNoble and scientific titles. These can assist in formulating oral and formal addresing titles. The CBB concept 'titles' is mapped to elements 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 CBB 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.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idHumanName.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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.
|
Mapping FHIR profile to CBB
Path | map | CBB |
---|---|---|
HumanName | NameInformation | HdBe-NameInformation |
HumanName.extension:nameUsage.value[x] | NameInformation.NameUsage | HdBe-NameInformation |
HumanName.family.extension:prefix.value[x] | NameInformation.LastName.Prefix | HdBe-NameInformation |
HumanName.family.extension:lastName.value[x] | NameInformation.LastName.LastName | HdBe-NameInformation |
HumanName.family.extension:partnerPrefix.value[x] | NameInformation.LastNamePartner.PartnerPrefix | HdBe-NameInformation |
HumanName.family.extension:partnerLastName.value[x] | NameInformation.LastNamePartner.PartnerLastName | HdBe-NameInformation |
HumanName.given | NameInformation.FirstNames | HdBe-NameInformation |
HumanName.given | NameInformation.Initials | HdBe-NameInformation |
HumanName.prefix | NameInformation.Titles | HdBe-NameInformation |
HumanName.suffix | NameInformation.Titles | HdBe-NameInformation |
HdBe-NameInformation is a datatype profile and can therefore not have an example of its own. Rather, an example is provided within the example of the HdBe-profile(s) that use this datatype profile.
zib-NameInformation difference
| Concept | Category | Description |
|-----------------|-------------------|-----------------------------------------|
|HumanName
(root) | textual | Made the implementation guidance in the comment more generic and removed Dutch context. |
|extension.nameUsage.value[x] | terminology | Adapted ConceptMap NameUsage-to-HumanNameAssemblyOrder in accordance with the changes in the ValueSet NameUsage. | |
family.extension:lastName.value[x]| textual | Added textual guidance that it is allowed to include
prefixin the
lastName for systems that do not record the prefix sperately, which is common in Belgium. | |
family.extension:lastName.value[x]| textual | Added textual guidance that it is allowed to include
partnerPrefixin the
partnerLastName` for systems that do not record the prefix sperately, which is common in Belgium. |
HdBe-NameInformation.GivenName
Instructions |
---|
This Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other Note 2: The examples illustrate how the CBB is mapped to FHIR. |
HumanName | HumanName | Element idHumanName Name of a human - parts and usage DefinitionThis slice represents the name information normally used to address the person. This Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other Note 2: The examples illustrate how the CBB is mapped to FHIR.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idHumanName.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 1..1 | codeBindingPattern | Element idHumanName.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
usual
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idHumanName.text Text representation of the full name 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. A renderable, unencoded form. 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.
|
family | Σ | 0..0 | string | There are no (further) constraints on this element Element idHumanName.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
given | Σ | 1..* | string | Element idHumanName.given GivenName Alternate namesfirst name, middle name, Roepnaam DefinitionThe name normally used to address the person. 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.
|
prefix | Σ | 0..0 | string | There are no (further) constraints on this element Element idHumanName.prefix Parts that come before the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
suffix | Σ | 0..0 | string | There are no (further) constraints on this element Element idHumanName.suffix Parts that come after the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idHumanName.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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.
|
HumanName | HumanName | Element idHumanName Name of a human - parts and usage DefinitionThis slice represents the name information normally used to address the person. This Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other Note 2: The examples illustrate how the CBB is mapped to FHIR.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idHumanName.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 1..1 | codeBindingPattern | Element idHumanName.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
usual
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idHumanName.text Text representation of the full name 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. A renderable, unencoded form. 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.
|
family | Σ | 0..0 | string | There are no (further) constraints on this element Element idHumanName.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
given | Σ | 1..* | string | Element idHumanName.given GivenName Alternate namesfirst name, middle name, Roepnaam DefinitionThe name normally used to address the person. 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.
|
prefix | Σ | 0..0 | string | There are no (further) constraints on this element Element idHumanName.prefix Parts that come before the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
suffix | Σ | 0..0 | string | There are no (further) constraints on this element Element idHumanName.suffix Parts that come after the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idHumanName.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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.
|
HumanName | HumanName | Element idHumanName Name of a human - parts and usage DefinitionThis slice represents the name information normally used to address the person. This Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other Note 2: The examples illustrate how the CBB is mapped to FHIR.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idHumanName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idHumanName.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 1..1 | codeBindingPattern | Element idHumanName.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
usual
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idHumanName.text Text representation of the full name 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. A renderable, unencoded form. 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.
|
family | Σ | 0..0 | string | There are no (further) constraints on this element Element idHumanName.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
given | Σ | 1..* | string | Element idHumanName.given GivenName Alternate namesfirst name, middle name, Roepnaam DefinitionThe name normally used to address the person. 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.
|
prefix | Σ | 0..0 | string | There are no (further) constraints on this element Element idHumanName.prefix Parts that come before the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
suffix | Σ | 0..0 | string | There are no (further) constraints on this element Element idHumanName.suffix Parts that come after the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idHumanName.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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.
|
Mapping FHIR profile to CBB
Path | map | CBB |
---|---|---|
HumanName | NameInformation | HdBe-NameInformation |
HumanName.extension:nameUsage.value[x] | NameInformation.NameUsage | HdBe-NameInformation |
HumanName.family.extension:prefix.value[x] | NameInformation.LastName.Prefix | HdBe-NameInformation |
HumanName.family.extension:lastName.value[x] | NameInformation.LastName.LastName | HdBe-NameInformation |
HumanName.family.extension:partnerPrefix.value[x] | NameInformation.LastNamePartner.PartnerPrefix | HdBe-NameInformation |
HumanName.family.extension:partnerLastName.value[x] | NameInformation.LastNamePartner.PartnerLastName | HdBe-NameInformation |
HumanName.given | NameInformation.FirstNames | HdBe-NameInformation |
HumanName.given | NameInformation.Initials | HdBe-NameInformation |
HumanName.prefix | NameInformation.Titles | HdBe-NameInformation |
HumanName.suffix | NameInformation.Titles | HdBe-NameInformation |
HdBe-NameInformation is a datatype profile and can therefore not have an example of its own. Rather, an example is provided within the example of the HdBe-profile(s) that use this datatype profile.
zib-NameInformation.GivenName difference
Concept | Category | Description |
---|---|---|
- | - | - |
Terminology Bindings
Path | Name | Strength | URL |
---|---|---|---|
HumanName.extension.value[x] | name-assembly-order|4.0.1 | required | http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1 |