HL7 FHIR JP Core ImplementationGuide
1.3.0-dev - ci-build
HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.3.0-dev) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
FHIRではリソース内に要素を記述する際、具体的なデータを含まない「空のオブジェクト」を作成することはできない。 具体的には、リソース(患者情報や検査結果といった情報のまとまり)の中に何らかの要素(例えば「患者さんの名前」や「検査日」といった個別のデータ項目)を記述する場合、その要素には必ず以下のいずれかの情報を含んでいる必要がある。
要素の種類に応じた具体的なデータ: 例えば、「患者さんの名前」という要素であれば、実際の名前の文字列(例: "山田 太郎")が入っている、といった具合である。要素が持つべき具体的なデータ値(例:string型なら文字列、integer型なら整数など)が必要になる。
少なくとも1つの「拡張 (extension)」: 標準で定義されていない情報を追加するための特別な仕組みである「拡張」が、少なくとも1つ設定されている必要がある。
特に文字列(string型)のデータ項目(例:自由記述のメモなど)は、FHIRのルールにより、空文字("")を値として使用することはできない。 もし文字列型の要素を記述するならば、必ず1文字以上のデータを含んでいる必要がある。
(これらのルールは、FHIR仕様の 2.6.2 JSON Representation of Resources, 2.6.1 XML Representation of Resources, および 2.24.0.1 Primitive Types に基づいている。)
そのため、データが利用できない、または不明な場合でも、空文字で代替することはできない。このような場合に対処するために、Data Absent Reason拡張 を用いて、データが欠損している理由を表現することが推奨される。
実装ガイド作成時に、多重度を1以上やMust Supportの付与を変更した場合は、欠損値の対処方法についてのルールをあらかじめ定めることを推奨する。
JP Coreにおいて多重度が設定された場合のルールは以下の通りである。 JP Core の検索要求を行うクライアント (Requester) およびサーバ (Responder) は以下の要求を満たさなければならない (SHALL)。
例)
Readインタラクションの応答として、Cardinalityが1以上の要素である Patient.maritalStatus
を含む Patient
リソースを受信した場合、要求者はその値をエラーなく処理しなければならない。
{
"resourceType": "Patient",
"maritalStatus": {
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "Married"
}]
}
}
例)
Patient.birthDate
の値に欠損情報が付与されているリソースを、要求者は処理できなければならない。なお、birthDate
はdate型というprimitive typeであり、そのextensionは"_"を先頭につけたプロパティに対して設定される(2.6.2.3 JSON representation of primitive elements)。
{
"resourceType": "Patient",
"_birthDate": {
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "unknown"
}]
}
}
JP Core 実装ガイドに準拠するサーバは、当該要素の値を保持している場合には、要求された検索結果のリソースのデータ要素として含めるべきである (SHOULD)。
JP Core 実装ガイドに準拠するサーバは、最小多重度が0の要素の値を保持していない場合、そのデータ要素の項目を省略してもよい (MAY)。
例)
Patient.telecom
が欠損している場合… telecom
要素は含まなくてよい。
{
"resourceType": "Patient",
"name": [{"family": "Yamada", "given": ["Taro"]}],
"gender": "male"
}
JP Core実装ガイドのサーバは、Cardinalityが1以上の要素の値を保持していない場合、次のように、データの欠損理由を指定しなければならない (SHALL)。
非コード化値の場合: Data Absent Reason拡張を使用して、欠損理由を送信できなければならない (SHALL)。
例)
患者の生年月日が不明なため、Patient.birthDate
に値を保持していない場合(Patient.birthDate
が必須 MustSupport)、Data Absent Reason拡張を使用して、欠損理由(=不明)を示す。なお、birthDate
はdate型というprimitive typeであり、そのextensionは"_"を先頭につけたプロパティに対して設定される(2.6.2.3 JSON representation of primitive elements)。
{
"resourceType": "Patient",
"_birthDate": {
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "unknown"
}]
}
}
a) そのコード化要素のバインディング強度が、example
, preferred
, extensible
のいずれかの場合
i. コード化値の代替となる文字情報を持っている場合は、当該要素の text
プロパティに、文字情報のみを設定する。
例)
Patient.maritalStatus
が必須要素の場合で、Patient.maritalStatus
のコード値はわからないが、「既婚」という文字情報は持っている場合、CodeableConcept
の text
を使用する。
{
"resourceType": "Patient",
"maritalStatus": {
"text": "既婚"
}
}
ii. コード化値の代替となる文字情報がない場合、バリューセットの中に例外値を表現するコードがあればその値を使用する。
例)
バリューセットに含まれる例外値を表現するコードを使用(ValueSet marital-status
には、不明な状態を表すコード UNK
(Unknown) を含んでいるため、UNK
を使用する)
{
"resourceType": "Patient",
"maritalStatus": {
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
"code": "UNK",
"display": "unknown"
}]
}
}
iii. コード化値の代替となる文字情報がなく、バリューセットの中に例外値を表現するコードが無い場合、Data Absent Reason拡張コード体系から、適切な概念コードを使用する。
例)
Patient.communication.language
の値が、患者に確認していないため不明の場合、Data Absent Reason拡張より「not-asked」を使用する。※Patient.communication.language
は現状のJP Core Patientプロファイル案では必須ではないため、例示のためのみに使用した。
{
"resourceType": "Patient",
"communication": [{
"language": {
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "not-asked",
"display": "Not asked"
}]
}
}]
}
b) そのコード化要素のバインディング強度が required
の場合
そのバリューセット内に含まれる例外値を表すコードを使用する。
例)
Patient.gender
の値が不明の場合、 バリューセット AdministrativeGender
に含まれる例外値を表すコード「unknown」を使用する。※Patient.gender
は現状のJP Core Patientプロファイル案では必須ではないため、例示のために使用した。
{
"resourceType": "Patient",
"gender": "unknown"
}