HL7 FHIR JP Core ImplementationGuide
1.1.1 - release
HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.1). See the Directory of published versions
項目 | 内容 |
定義URL | http://jpfhir.jp/fhir/core/StructureDefinition/JP_Observation_LabResult |
Version | 1.1.1 |
Name | JP_Observation_LabResult |
Title | JP Core Observation LabResult Profile |
Status | Active ( 2022-10-24 ) |
Copyright | Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG |
このプロファイルはObservationリソースに対して、検体検査結果のデータを送受信するための制約と拡張を定めたものである。
本プロファイル説明は、患者に関連付けられた検体検査結果を記録、検索、および取得のために、FHIR Observationリソースを使用するにあたっての、最低限の制約を記述したものである。
Observationリソースに対して本プロファイルに準拠する場合に必須となる要素や、サポートすべき拡張、用語、検索パラメータを定義する。
なお、検査結果は、Observationリソースを参照するDiagnosticReportリソースを使用してグループ化および要約されたものである。各Observationリソースは、個々の検体検査と結果値、他の観察結果を参照する。
本プロファイルは、以下のようなユースケースを想定している。
Observationはヘルスケアの中心的な要素であり、診断の支援、進捗状況の監視、ベースラインやパターンの決定、さらには人口統計学的特性の把握に使用される。ほとんどのObservationは、いくつかのメタデータを持つ単純な名前/値のペアのアサーションであるが、いくつかのObservationは、他の Observationを論理的にグループ化したり、あるいはマルチコンポーネントのObservationであったりする。
本プロファイルでは上記想定シナリオにて用いられるObservationの用途がスコープであり、患者基本情報の中でも特に検体検査に該当する情報項目の1つを取り扱う際に、必要な要件を定義している。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from JP_Observation_Common
Summary
Mandatory: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | JP_Observation_Common | 検体検査結果 | |
identifier | 0..* | Identifier | 当該検査項目に対して、施設内で割り振られる一意の識別子 | |
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
value | 0..1 | string | The value that is unique | |
basedOn | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order 実施されるプラン、提案、依頼 | |
partOf | 0..* | Reference(JP Core MedicationAdministration Profile | JP Core MedicationAdministration Injection Profile | JP Core MedicationDispenseBase Profile | MedicationStatement | JP Core Procedure Profile | JP Core Immunization Profile | ImagingStudy) | Part of referenced event 参照されるイベントの一部分 | |
status | 1..1 | code | registered | preliminary | final | amended + | |
Slices for category | 1..* | CodeableConcept | Classification of type of observation Observationの種類(タイプ)の分類 Slice: Unordered, Open by pattern:$this | |
category:All Slices | Content/Rules for all slices | |||
coding | 0..* | Coding | Code defined by a terminology system | |
category:laboratory | 1..1 | CodeableConcept | Classification of type of observation Observationの種類(タイプ)の分類 Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |
code | 1..1 | CodeableConcept | Type of observation (code / type) observation のタイプ(コードまたはタイプ) Binding: JP Core Observation LabResult Code ValueSet (preferred): MEDIS 臨床検査マスター | |
coding | 1..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 1..1 | string | Plain text representation of the concept | |
subject | 1..1 | Reference(JP Core Patient Profile) | Who and/or what the observation is about 観察対象者 | |
focus | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record subject 要素が実際のobservationの対象でない場合に、observation の対象物 | |
encounter | 0..1 | Reference(JP Core Encounter Profile) | Healthcare event during which this observation is made このobservationが行われるヘルスケアイベント | |
effective[x] | 1..1 | Clinically relevant time/time-period for observation 臨床的に関連する時刻または時間 | ||
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
issued | 0..1 | instant | Date/Time this version was made available このバージョンが利用可能となった日時 | |
performer | 0..* | Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile | CareTeam | JP Core Patient Profile | RelatedPerson) | Who is responsible for the observation observationに責任をもつ者 | |
value[x] | 0..1 | 同じ検査項目でも、システム(施設)により、使うデータ型が異なる可能性あり。【詳細参照】 Slice: Unordered, Open by type:$this | ||
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueQuantity | 0..1 | Quantity | 検査結果が「数値」の場合、値、単位を設定する。 SS-MIX2/HL7 V2.5→ OBX-2=「NM」の時の OBX-5(結果値)、OBX-6(単位)【詳細参照】 | |
valueCodeableConcept | 0..1 | CodeableConcept | 検査結果が「コード値」の場合、コード、テキスト、コードのValue setを定義する。 SS-MIX2/HL7 V2.5→ OBX-2=「CWE」の時の OBX-5(結果値)【詳細参照】 | |
valueString | 0..1 | string | 検査結果値が「文字列」の場合、その文字列を指定する。SS-MIX2/HL7 V2.5→ OBX-2=「ST」の時の OBX-5(結果値) | |
dataAbsentReason | 0..1 | CodeableConcept | Why the result is missing 結果が欠損値である理由 | |
interpretation | 0..* | CodeableConcept | High, low, normal, etc. 高、低、正常など | |
note | 0..* | Annotation | Comments about the observation 結果に対するコメント | |
time | 0..1 | dateTime | When the annotation was made | |
text | 1..1 | markdown | The annotation - text content (as markdown) | |
bodySite | 0..1 | CodeableConcept | Bindingについてはユースケースに応じて各プロファイルで定義すること | |
method | 0..1 | CodeableConcept | How it was done 実施の方法 | |
specimen | 1..1 | Reference(Specimen) | Specimen used for this observation 観察(観測、検査)に使われた検体材料 | |
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device 測定機器 | |
referenceRange | 0..* | BackboneElement | Provides guide for interpretation 解釈のためのガイドを与える | |
low | 0..1 | SimpleQuantity | Low Range, if relevant | |
high | 0..1 | SimpleQuantity | High Range, if relevant | |
type | 0..1 | CodeableConcept | Reference range qualifier | |
appliesTo | 0..* | CodeableConcept | Reference range population | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
hasMember | 0..* | Reference(JP Core Observation Common Profile | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group observationグループに属する関連リソース | |
derivedFrom | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | JP Core Observation Common Profile | MolecularSequence) | Related measurements the observation is made from observation が作られる元の関連する測定 | |
component | 0..* | BackboneElement | Component results コンポーネント結果 | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | JP_Observation_Common | 検体検査結果 | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | 当該検査項目に対して、施設内で割り振られる一意の識別子 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
basedOn | Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order 実施されるプラン、提案、依頼 | ||||
partOf | Σ | 0..* | Reference(JP Core MedicationAdministration Profile | JP Core MedicationAdministration Injection Profile | JP Core MedicationDispenseBase Profile | MedicationStatement | JP Core Procedure Profile | JP Core Immunization Profile | ImagingStudy) | Part of referenced event 参照されるイベントの一部分 | ||||
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
Slices for category | 1..* | CodeableConcept | Classification of type of observation Observationの種類(タイプ)の分類 Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
category:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
category:laboratory | 1..1 | CodeableConcept | Classification of type of observation Observationの種類(タイプ)の分類 Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) observation のタイプ(コードまたはタイプ) Binding: JP Core Observation LabResult Code ValueSet (preferred): MEDIS 臨床検査マスター | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 1..1 | string | Plain text representation of the concept | ||||
subject | Σ | 1..1 | Reference(JP Core Patient Profile) | Who and/or what the observation is about 観察対象者 | ||||
focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record subject 要素が実際のobservationの対象でない場合に、observation の対象物 | ||||
encounter | Σ | 0..1 | Reference(JP Core Encounter Profile) | Healthcare event during which this observation is made このobservationが行われるヘルスケアイベント | ||||
effective[x] | Σ | 1..1 | Clinically relevant time/time-period for observation 臨床的に関連する時刻または時間 | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
effectiveTiming | Timing | |||||||
issued | Σ | 0..1 | instant | Date/Time this version was made available このバージョンが利用可能となった日時 | ||||
performer | Σ | 0..* | Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile | CareTeam | JP Core Patient Profile | RelatedPerson) | Who is responsible for the observation observationに責任をもつ者 | ||||
Slices for value[x] | ΣC | 0..1 | 同じ検査項目でも、システム(施設)により、使うデータ型が異なる可能性あり。【詳細参照】 Slice: Unordered, Closed by type:$this | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | 検査結果が「数値」の場合、値、単位を設定する。 SS-MIX2/HL7 V2.5→ OBX-2=「NM」の時の OBX-5(結果値)、OBX-6(単位)【詳細参照】 | ||||
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | 検査結果が「コード値」の場合、コード、テキスト、コードのValue setを定義する。 SS-MIX2/HL7 V2.5→ OBX-2=「CWE」の時の OBX-5(結果値)【詳細参照】 | ||||
value[x]:valueString | ΣC | 0..1 | string | 検査結果値が「文字列」の場合、その文字列を指定する。SS-MIX2/HL7 V2.5→ OBX-2=「ST」の時の OBX-5(結果値) | ||||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing 結果が欠損値である理由 Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
interpretation | 0..* | CodeableConcept | High, low, normal, etc. 高、低、正常など Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
note | 0..* | Annotation | Comments about the observation 結果に対するコメント | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
bodySite | 0..1 | CodeableConcept | Bindingについてはユースケースに応じて各プロファイルで定義すること Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
method | 0..1 | CodeableConcept | How it was done 実施の方法 Binding: ObservationMethods (example): Methods for simple observations. | |||||
specimen | 1..1 | Reference(Specimen) | Specimen used for this observation 観察(観測、検査)に使われた検体材料 | |||||
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device 測定機器 | |||||
referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation 解釈のためのガイドを与える | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
age | 0..1 | Range | Applicable age range, if relevant | |||||
text | 0..1 | string | Text based reference range in an observation | |||||
hasMember | Σ | 0..* | Reference(JP Core Observation Common Profile | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group observationグループに属する関連リソース | ||||
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | JP Core Observation Common Profile | MolecularSequence) | Related measurements the observation is made from observation が作られる元の関連する測定 | ||||
component | Σ | 0..* | BackboneElement | Component results コンポーネント結果 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
value[x] | Σ | 0..1 | Actual component result | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
Documentation for this format |
Terminology Bindings
Path | Conformance | ValueSet / Code | ||||
Observation.language | preferred | CommonLanguages
| ||||
Observation.identifier.use | required | IdentifierUse | ||||
Observation.identifier.type | extensible | Identifier Type Codes | ||||
Observation.status | required | ObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.category:laboratory | preferred | Pattern: laboratory | ||||
Observation.code | preferred | JP_ObservationLabResultCode_VS (a valid code from urn:oid:1.2.392.200119.4.504 ) | ||||
Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
Observation.method | example | ObservationMethods | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes |
Constraints
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() |
This structure is derived from JP_Observation_Common
Summary
Mandatory: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | JP_Observation_Common | 検体検査結果 | |
identifier | 0..* | Identifier | 当該検査項目に対して、施設内で割り振られる一意の識別子 | |
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
value | 0..1 | string | The value that is unique | |
basedOn | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order 実施されるプラン、提案、依頼 | |
partOf | 0..* | Reference(JP Core MedicationAdministration Profile | JP Core MedicationAdministration Injection Profile | JP Core MedicationDispenseBase Profile | MedicationStatement | JP Core Procedure Profile | JP Core Immunization Profile | ImagingStudy) | Part of referenced event 参照されるイベントの一部分 | |
status | 1..1 | code | registered | preliminary | final | amended + | |
Slices for category | 1..* | CodeableConcept | Classification of type of observation Observationの種類(タイプ)の分類 Slice: Unordered, Open by pattern:$this | |
category:All Slices | Content/Rules for all slices | |||
coding | 0..* | Coding | Code defined by a terminology system | |
category:laboratory | 1..1 | CodeableConcept | Classification of type of observation Observationの種類(タイプ)の分類 Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |
code | 1..1 | CodeableConcept | Type of observation (code / type) observation のタイプ(コードまたはタイプ) Binding: JP Core Observation LabResult Code ValueSet (preferred): MEDIS 臨床検査マスター | |
coding | 1..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 1..1 | string | Plain text representation of the concept | |
subject | 1..1 | Reference(JP Core Patient Profile) | Who and/or what the observation is about 観察対象者 | |
focus | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record subject 要素が実際のobservationの対象でない場合に、observation の対象物 | |
encounter | 0..1 | Reference(JP Core Encounter Profile) | Healthcare event during which this observation is made このobservationが行われるヘルスケアイベント | |
effective[x] | 1..1 | Clinically relevant time/time-period for observation 臨床的に関連する時刻または時間 | ||
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
issued | 0..1 | instant | Date/Time this version was made available このバージョンが利用可能となった日時 | |
performer | 0..* | Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile | CareTeam | JP Core Patient Profile | RelatedPerson) | Who is responsible for the observation observationに責任をもつ者 | |
value[x] | 0..1 | 同じ検査項目でも、システム(施設)により、使うデータ型が異なる可能性あり。【詳細参照】 Slice: Unordered, Open by type:$this | ||
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueQuantity | 0..1 | Quantity | 検査結果が「数値」の場合、値、単位を設定する。 SS-MIX2/HL7 V2.5→ OBX-2=「NM」の時の OBX-5(結果値)、OBX-6(単位)【詳細参照】 | |
valueCodeableConcept | 0..1 | CodeableConcept | 検査結果が「コード値」の場合、コード、テキスト、コードのValue setを定義する。 SS-MIX2/HL7 V2.5→ OBX-2=「CWE」の時の OBX-5(結果値)【詳細参照】 | |
valueString | 0..1 | string | 検査結果値が「文字列」の場合、その文字列を指定する。SS-MIX2/HL7 V2.5→ OBX-2=「ST」の時の OBX-5(結果値) | |
dataAbsentReason | 0..1 | CodeableConcept | Why the result is missing 結果が欠損値である理由 | |
interpretation | 0..* | CodeableConcept | High, low, normal, etc. 高、低、正常など | |
note | 0..* | Annotation | Comments about the observation 結果に対するコメント | |
time | 0..1 | dateTime | When the annotation was made | |
text | 1..1 | markdown | The annotation - text content (as markdown) | |
bodySite | 0..1 | CodeableConcept | Bindingについてはユースケースに応じて各プロファイルで定義すること | |
method | 0..1 | CodeableConcept | How it was done 実施の方法 | |
specimen | 1..1 | Reference(Specimen) | Specimen used for this observation 観察(観測、検査)に使われた検体材料 | |
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device 測定機器 | |
referenceRange | 0..* | BackboneElement | Provides guide for interpretation 解釈のためのガイドを与える | |
low | 0..1 | SimpleQuantity | Low Range, if relevant | |
high | 0..1 | SimpleQuantity | High Range, if relevant | |
type | 0..1 | CodeableConcept | Reference range qualifier | |
appliesTo | 0..* | CodeableConcept | Reference range population | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
hasMember | 0..* | Reference(JP Core Observation Common Profile | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group observationグループに属する関連リソース | |
derivedFrom | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | JP Core Observation Common Profile | MolecularSequence) | Related measurements the observation is made from observation が作られる元の関連する測定 | |
component | 0..* | BackboneElement | Component results コンポーネント結果 | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | JP_Observation_Common | 検体検査結果 | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | 当該検査項目に対して、施設内で割り振られる一意の識別子 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
basedOn | Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order 実施されるプラン、提案、依頼 | ||||
partOf | Σ | 0..* | Reference(JP Core MedicationAdministration Profile | JP Core MedicationAdministration Injection Profile | JP Core MedicationDispenseBase Profile | MedicationStatement | JP Core Procedure Profile | JP Core Immunization Profile | ImagingStudy) | Part of referenced event 参照されるイベントの一部分 | ||||
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
Slices for category | 1..* | CodeableConcept | Classification of type of observation Observationの種類(タイプ)の分類 Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
category:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
category:laboratory | 1..1 | CodeableConcept | Classification of type of observation Observationの種類(タイプ)の分類 Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) observation のタイプ(コードまたはタイプ) Binding: JP Core Observation LabResult Code ValueSet (preferred): MEDIS 臨床検査マスター | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 1..1 | string | Plain text representation of the concept | ||||
subject | Σ | 1..1 | Reference(JP Core Patient Profile) | Who and/or what the observation is about 観察対象者 | ||||
focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record subject 要素が実際のobservationの対象でない場合に、observation の対象物 | ||||
encounter | Σ | 0..1 | Reference(JP Core Encounter Profile) | Healthcare event during which this observation is made このobservationが行われるヘルスケアイベント | ||||
effective[x] | Σ | 1..1 | Clinically relevant time/time-period for observation 臨床的に関連する時刻または時間 | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
effectiveTiming | Timing | |||||||
issued | Σ | 0..1 | instant | Date/Time this version was made available このバージョンが利用可能となった日時 | ||||
performer | Σ | 0..* | Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile | CareTeam | JP Core Patient Profile | RelatedPerson) | Who is responsible for the observation observationに責任をもつ者 | ||||
Slices for value[x] | ΣC | 0..1 | 同じ検査項目でも、システム(施設)により、使うデータ型が異なる可能性あり。【詳細参照】 Slice: Unordered, Closed by type:$this | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | 検査結果が「数値」の場合、値、単位を設定する。 SS-MIX2/HL7 V2.5→ OBX-2=「NM」の時の OBX-5(結果値)、OBX-6(単位)【詳細参照】 | ||||
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | 検査結果が「コード値」の場合、コード、テキスト、コードのValue setを定義する。 SS-MIX2/HL7 V2.5→ OBX-2=「CWE」の時の OBX-5(結果値)【詳細参照】 | ||||
value[x]:valueString | ΣC | 0..1 | string | 検査結果値が「文字列」の場合、その文字列を指定する。SS-MIX2/HL7 V2.5→ OBX-2=「ST」の時の OBX-5(結果値) | ||||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing 結果が欠損値である理由 Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
interpretation | 0..* | CodeableConcept | High, low, normal, etc. 高、低、正常など Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
note | 0..* | Annotation | Comments about the observation 結果に対するコメント | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
bodySite | 0..1 | CodeableConcept | Bindingについてはユースケースに応じて各プロファイルで定義すること Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
method | 0..1 | CodeableConcept | How it was done 実施の方法 Binding: ObservationMethods (example): Methods for simple observations. | |||||
specimen | 1..1 | Reference(Specimen) | Specimen used for this observation 観察(観測、検査)に使われた検体材料 | |||||
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device 測定機器 | |||||
referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation 解釈のためのガイドを与える | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
age | 0..1 | Range | Applicable age range, if relevant | |||||
text | 0..1 | string | Text based reference range in an observation | |||||
hasMember | Σ | 0..* | Reference(JP Core Observation Common Profile | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group observationグループに属する関連リソース | ||||
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | JP Core Observation Common Profile | MolecularSequence) | Related measurements the observation is made from observation が作られる元の関連する測定 | ||||
component | Σ | 0..* | BackboneElement | Component results コンポーネント結果 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
value[x] | Σ | 0..1 | Actual component result | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
Documentation for this format |
Terminology Bindings
Path | Conformance | ValueSet / Code | ||||
Observation.language | preferred | CommonLanguages
| ||||
Observation.identifier.use | required | IdentifierUse | ||||
Observation.identifier.type | extensible | Identifier Type Codes | ||||
Observation.status | required | ObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.category:laboratory | preferred | Pattern: laboratory | ||||
Observation.code | preferred | JP_ObservationLabResultCode_VS (a valid code from urn:oid:1.2.392.200119.4.504 ) | ||||
Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
Observation.method | example | ObservationMethods | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes |
Constraints
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() |
Other representations of profile: CSV, Excel, Schematron
本プロファイルでは、次の要素を持たなければならない。
本プロファイルで追加定義された拡張はない。
検体検査結果ユースケースのSearch Parameter一覧は共通情報プロファイルとは異なり以下の通りである。
コンフォーマンス | パラメータ | 型 | 例 |
---|---|---|---|
SHOULD | patient,code,date,based-on | reference,token,date,reference | GET [base]/Observation?patient=123&code=urn:oid:1.2.392.200119.4.504|9A610000000000000&date=le2020-12-31&based-on=ServiceRequest/456 |
SHOULD | patient,code,date,value-quantity,based-on | reference,token,date,quantity,reference | GET [base]/Observation?patient=123&code=urn:oid:1.2.392.200119.4.504|9A610000000000000&date=le2020-12-31&value-quantity=gt40&based-on=ServiceRequest/456 |
SHOULD | patient,code,date,value-concept,based-on | reference,token,date,code,reference | GET [base]/Observation?patient=123&code=urn:oid:1.2.392.200119.4.504|9A610000000000000&date=le2020-12-31&value-concept=http://jpfhir.jp/fhir/example|1082004&based-on=ServiceRequest/456 |
SHOULD | patient,code,date,value-string,based-on | reference,token,date,string,reference | GET [base]/Observation?patient=123&code=urn:oid:1.2.392.200119.4.504|9A610000000000000&date=le2020-12-31&value-string=positive&based-on=ServiceRequest/456 |
SHOULD | code,value-quantity,patient | token,quantity,reference | GET [base]/Observation?code=urn:oid:1.2.392.200119.4.504|9A610000000000000&value-quantity=gt40&patient=123 |
SHOULD | code,value-concept,patient | token,code,reference | GET [base]/Observation?code=urn:oid:1.2.392.200119.4.504|9A610000000000000&value-concept=http://jpfhir.jp/fhir/example|1082004&patient=123 |
SHOULD | code,value-string,patient | token,string,reference | GET [base]/Observation?code=urn:oid:1.2.392.200119.4.504|9A610000000000000&value-string=positive&patient=123 |
必須(SHALL)としての検索項目は定義しない。
次の検索パラメータはサポートすることが推奨される。(SHOULD)
subject = Patient
(対象患者)、検体採取日、検査項目、basedOn = ServiceRequest
(検査オーダの依頼科)を指定した検索をサポートすることが望ましい。(SHOULD)patient,code,date,based-on の各検索パラメータに一致するObservationリソースを含むBundleを取得することができる。
GET [base]/Observation?patient={reference}&code={code}}&date={date}}&based-on={reference}
例:
GET [base]/Observation?patient=123&code=urn:oid:1.2.392.200119.4.504|9A610000000000000&date=le2020-12-31&based-on=ServiceRequest/456
subject = Patient
(対象患者)、検査項目、検査値(数値、条件:基準値から外れている、等)、basedOn = ServiceRequest
(検査オーダの依頼科)を指定した検索をサポートすることが望ましい。(SHOULD)patient,code,date,value-quantity,based-on の各検索パラメータに一致するObservationリソースを含むBundleを取得することができる。
GET [base]/Observation?patient={reference}&code={code}}&date={date}}&value-quantity={quantity}&based-on={reference}
例:
GET [base]/Observation?patient=123&code=urn:oid:1.2.392.200119.4.504|9A610000000000000&date=le2020-12-31&value-quantity=gt40&based-on=ServiceRequest/456
subject = Patient
(対象患者)、検査項目、検査値(コード)、basedOn = ServiceRequest
(検査オーダの依頼科)を指定した検索をサポートすることが望ましい。(SHOULD)patient,code,date,value-concept,based-on の各検索パラメータに一致するObservationリソースを含むBundleを取得することができる。
GET [base]/Observation?patient={reference}&code={code}}&date={date}}&value-concept={code}&based-on={reference}
例:
GET [base]/Observation?patient=123&code=urn:oid:1.2.392.200119.4.504|9A610000000000000&date=le2020-12-31&value-concept=http://jpfhir.jp/fhir/example|1082004&based-on=ServiceRequest/456
subject = Patient
(対象患者)、検査項目、検査値(文字列)、basedOn = ServiceRequest
(検査オーダの依頼科)を指定した検索をサポートすることが望ましい。(SHOULD)patient,code,date,value-string,based-on の各検索パラメータに一致するObservationリソースを含むBundleを取得することができる。
GET [base]/Observation?patient={reference}&code={code}}&date={date}}&value-string={string}&based-on={reference}
例:
GET [base]/Observation?patient=123&code=urn:oid:1.2.392.200119.4.504|9A610000000000000&date=le2020-12-31&value-string=positive&based-on=ServiceRequest/456
subject = Patient
(対象患者で絞る場合あり)を指定した検索をサポートすることが望ましい。(SHOULD)code,value-quantity,patient の各検索パラメータに一致するObservationリソースを含むBundleを取得することができる。
GET [base]/Observation?code={code}}&value-quantity={quantity}&patient={reference}&
例:
GET [base]/Observation?code=urn:oid:1.2.392.200119.4.504|9A610000000000000&value-quantity=gt40&patient=123
subject = Patient
(対象患者で絞る場合あり)を指定した検索をサポートすることが望ましい。(SHOULD)code,value-concept,patient の各検索パラメータに一致するObservationリソースを含むBundleを取得することができる。
GET [base]/Observation?code={code}}&value-concept={code}&patient={reference}
例:
GET [base]/Observation?code=urn:oid:1.2.392.200119.4.504|9A610000000000000&value-concept=http://jpfhir.jp/fhir/example|1082004&patient=123
subject = Patient
(対象患者で絞る場合あり)を指定した検索をサポートすることが望ましい。(SHOULD)code,value-string,patient の各検索パラメータに一致するObservationリソースを含むBundleを取得することができる。
GET [base]/Observation?code={code}}&value-string={string}&patient={reference}
例:
GET [base]/Observation?code=urn:oid:1.2.392.200119.4.504|9A610000000000000&value-string=positive&patient=123
本プロファイルで追加定義されたオプション検索パラメータはない。
ObservationリソースのOperation一覧の定義はユースケースに依存せず共通であるため、共通情報プロファイルに記載されている。
Observation共通情報プロファイル#Operation一覧