HL7 FHIR JP Core ImplementationGuide
1.1.2-clins - ci-build Japan

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.2-clins) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: JP Core HumanName DataType

項目内容
定義URL http://jpfhir.jp/fhir/core/StructureDefinition/JP_HumanName
Version 1.1.2-clins
Name

JP_HumanName
Title

JP Core HumanName DataType
Status Active ( 2023-06-26 )
Copyright

Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG

このデータタイプはHumanName DataTypeに対して、患者データを送受信するための基礎となる制約と拡張を定めたものである。


Usages:

You can also check for usages in the FHIR IG Statistics

プロファイル詳細

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from HumanName

Summary

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HumanName 0..* HumanName 人の名前情報、その一部分と使い方
... Slices for extension Content/Rules for all slices
.... extension:nameRepresentationUse 0..1 code ABC | IDE | SYL
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation
Binding: NameRepresentationUse (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HumanName 0..* HumanName 人の名前情報、その一部分と使い方
... id 0..1 string 要素間参照のための一意のID / Unique id for inter-element referencing
... Slices for extension 0..* Extension 実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:nameRepresentationUse 0..1 code ABC | IDE | SYL
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation
Binding: NameRepresentationUse (required)
... use ?!Σ 0..1 code 通常|公式|一時的|ニックネーム|匿名|古い|旧姓 / usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): 人間名の使用。 / The use of a human name.
... text Σ 0..1 string フルネームのテキスト表現 / Text representation of the full name
... family Σ 0..1 string 姓 / Family name (often called 'Surname')
... given Σ 0..* string 指定された名前（常に「最初」ではありません）。ミドルネームが含まれています / Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... prefix Σ 0..* string 名前の前に来るパーツ / Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
... suffix Σ 0..* string 名前の後に来るパーツ / Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... period Σ 0..1 Period 名前が使用されていた期間 / Time period when name was/is in use

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HumanName.use Base required NameUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements すべてのFHIR要素には、@valueまたは子要素が必要です / All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 両方ではなく、拡張または値[x]が必要です / Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from HumanName

Summary

Extensions

This structure refers to these extensions:

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HumanName 0..* HumanName 人の名前情報、その一部分と使い方
... Slices for extension Content/Rules for all slices
.... extension:nameRepresentationUse 0..1 code ABC | IDE | SYL
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation
Binding: NameRepresentationUse (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HumanName 0..* HumanName 人の名前情報、その一部分と使い方
... id 0..1 string 要素間参照のための一意のID / Unique id for inter-element referencing
... Slices for extension 0..* Extension 実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:nameRepresentationUse 0..1 code ABC | IDE | SYL
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation
Binding: NameRepresentationUse (required)
... use ?!Σ 0..1 code 通常|公式|一時的|ニックネーム|匿名|古い|旧姓 / usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): 人間名の使用。 / The use of a human name.
... text Σ 0..1 string フルネームのテキスト表現 / Text representation of the full name
... family Σ 0..1 string 姓 / Family name (often called 'Surname')
... given Σ 0..* string 指定された名前（常に「最初」ではありません）。ミドルネームが含まれています / Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... prefix Σ 0..* string 名前の前に来るパーツ / Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
... suffix Σ 0..* string 名前の後に来るパーツ / Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... period Σ 0..1 Period 名前が使用されていた期間 / Time period when name was/is in use

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HumanName.use Base required NameUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements すべてのFHIR要素には、@valueまたは子要素が必要です / All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 両方ではなく、拡張または値[x]が必要です / Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron

人名表記に関する説明

表記分類

JP_HumanNameは名前の表記分類としてiso21090-EN-representation extensionを0..1の多重度にて拡張として割り当てている。具体的な表記分類に利用されるコードはvalueset-name-v3-representationのValueSetにて３つのコードが指定されている。

  • IDE ： 表意文字
    日本語の氏名では、主に漢字氏名に相当するエリアになる。漢字を利用していない氏名についてはひらがなやカタカナ、アルファベットも可能であるが全角を利用すること。
  • SYL ： 表音文字
    全角カタカナで記載する。
  • ABC ： アルファベット
    日本語の氏名の場合、主にローマ字を割り当てる。ローマ字の記述方法には、ヘボン式と訓令式があるが現在決まりはないが、一般にはヘボン式のほうが利用されることが多い。このエリアを検索等に利用する場合には、規則を決めておくことをお勧めする。

iso21090-EN-representation extensionの多重度

JP Coreでは国外ベンダを考慮し、iso21090-EN-representation extensionの拡張は多重度0を許容している。実装ガイド作成の際は、アプリケーションの実装等やデータ収集の精度を考慮した上で多重度を決定すること。

textの区切り文字

textには氏名全体を結合し格納する。family、given等の各組み合わせる時の区切り文字は検索時の利便性を考慮し、「半角スペース」で統一する(SHALL)。

表記分類ごと記述

code 説明 text family given
IDE 表意文字 山田 太郎 山田 太郎
SYL 表音文字 ヤマダ タロウ ヤマダ タロウ
ABC アルファベット YAMADA TARO YAMADA TARO

リソースでの記述例

 "name" : [
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation",
          "valueCode" : "IDE"
        }
      ],
      "use" : "usual",
      "text" : "山田 太郎",
      "family" : "山田",
      "given" : [
        "太郎"
      ]
    },
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation",
          "valueCode" : "SYL"
        }
      ],
      "use" : "usual",
      "text" : "ヤマダ タロウ",
      "family" : "ヤマダ",
      "given" : [
        "タロウ"
      ]
    },
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation",
          "valueCode" : "ABC"
        }
      ],
      "use" : "usual",
      "text" : "YAMADA TARO",
      "family" : "YAMADA",
      "given" : [
        "TARO"
      ]
    }
  ]