SEAMAT2FHIR ドラフト版
0.1.1 - draft Japan

Publish Box goes here

Resource Profile: SEAMAT Common Observation Profile

項目内容
定義URL http://jpfhir.jp/fhir/SEAMAT/StructureDefinition/JP_Observation_SEAMAT
Version 0.1.1
Name

JP_Observation_SEAMAT
Title

SEAMAT Common Observation Profile
Status Active ( 2023-11-13 )
Copyright

Copyright (temporaly) by SIP D1 SEAMAT2FHIR WG, CC(Creative Commons license) BY-ND CC表示・改変禁止

このプロファイルはObservationリソースに対して、SEAMAT共通の測定結果／解析結果のデータを送受信するための制約と拡張を定めたものである。


Usage:

プロファイル詳細

This structure is derived from JP_Observation_Common

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* JP_Observation_Common SEAMATの測定結果／解析結果
observation-metaprofile: meta.profileには、指定したプロファイルのURLの記述が存在しなければならない。
... meta
.... lastUpdated S 1..1 instant リソースのバージョンが最後に変更されたとき
.... profile S 1..* canonical(StructureDefinition) このリソースが適合を主張するプロファイル
... Slices for identifier S 1..* Identifier このObservationリソースの一意な識別ID
Slice: Unordered, Open by value:system
.... identifier:resourceId S 0..1 Identifier このObservationリソースの一意な識別ID
..... system 1..1 uri 識別子値の名前空間 / The namespace for the identifier value
Fixed Value: http://jpfhir.jp/fhir/core/IdSystem/resourceInstance-identifier
..... value S 1..1 string 一意の値 / The value that is unique
.... identifier:bundleId S 1..1 Identifier 文書Bundleの固定識別番号。
..... system 1..1 uri 識別子値の名前空間 / The namespace for the identifier value
Fixed Value: http://jpfhir.jp/fhir/core/IdSystem/documentInstance-identifier
..... value S 1..1 string 一意の値 / The value that is unique
... status 1..1 code 結果の状態
Fixed Value: final
... code 1..1 CodeableConcept このObservationの対象を特定するコード
... subject 1..1 Reference(SEAMAT Common Patient Profile) このObservationの対象となる患者や患者群、機器、場所に関する情報
... value[x] S 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period 取得された結果
... dataAbsentReason 0..1 CodeableConcept このObservationのvalue[x]要素に期待される結果が存在しなかった場合、その理由
... component
.... code 1..1 CodeableConcept コンポーネント観測の種類（コード /タイプ） / Type of component observation (code / type)
.... value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period 実際のコンポーネントの結果 / Actual component result
.... dataAbsentReason 0..1 CodeableConcept コンポーネントの結果が欠落している理由 / Why the component result is missing

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* JP_Observation_Common SEAMATの測定結果／解析結果
obs-6: databsentrasonは、観察.value [x]が存在しない場合にのみ存在するものとします / dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: visserveration.codeがvisserveration.component.codeと同じ場合、コードに関連付けられている値要素が存在しないでください / If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
observation-metaprofile: meta.profileには、指定したプロファイルのURLの記述が存在しなければならない。
... id Σ 0..1 id このアーティファクトの論理ID / Logical id of this artifact
... meta Σ 0..1 Meta リソースに関するメタデータ / Metadata about the resource
.... id 0..1 string エレメント相互参照のためのユニークID
.... extension 0..* Extension 実装によって定義される追加コンテンツ
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id バージョン固有の識別子 (Baajon koyū no shikibetsu-shi)
.... lastUpdated SΣ 1..1 instant リソースのバージョンが最後に変更されたとき
.... source Σ 0..1 uri 「リソースがどこから来たかを特定する」
.... profile SΣ 1..* canonical(StructureDefinition) このリソースが適合を主張するプロファイル
.... security Σ 0..* Coding このリソースに適用されたセキュリティラベル
Binding: All Security Labels (extensible): 医療プライバシーおよびセキュリティ分類システムからのセキュリティラベル。


.... tag Σ 0..* Coding このリソースに適用されたタグ
Binding: CommonTags (example): 様々なタグを表すコードで、一般的にはワークフローに関連しています。例：「ジョーンズ博士によるレビューが必要です」。


... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
... Slices for identifier SΣ 1..* Identifier このObservationリソースの一意な識別ID
Slice: Unordered, Open by value:system
.... identifier:resourceId SΣ 0..1 Identifier このObservationリソースの一意な識別ID
..... id 0..1 string 要素間参照のための一意のID / 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 Σ 1..1 uri 識別子値の名前空間 / The namespace for the identifier value
Fixed Value: http://jpfhir.jp/fhir/core/IdSystem/resourceInstance-identifier
..... value SΣ 1..1 string 一意の値 / The value that is unique
..... period Σ 0..1 Period IDが使用に有効だった時間期間 / Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) IDを発行した組織（単なるテキストである可能性があります） / Organization that issued id (may be just text)
.... identifier:bundleId SΣ 1..1 Identifier 文書Bundleの固定識別番号。
..... id 0..1 string 要素間参照のための一意のID / 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 Σ 1..1 uri 識別子値の名前空間 / The namespace for the identifier value
Fixed Value: http://jpfhir.jp/fhir/core/IdSystem/documentInstance-identifier
..... value SΣ 1..1 string 一意の値 / The value that is unique
..... period Σ 0..1 Period IDが使用に有効だった時間期間 / Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) IDを発行した組織（単なるテキストである可能性があります） / Organization that issued id (may be just text)
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | JP Core MedicationRequest Profile | JP Core MedicationRequest Injection Profile | NutritionOrder | ServiceRequest) このObservationが実施されることになった依頼や計画、提案に関する情報
... 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) このObservationが親イベントの一部を成す要素であるとき、その親イベントに関する情報
... status ?!Σ 1..1 code 結果の状態
Binding: ObservationStatus (required): 観察のステータスを提供するコード。 / Codes providing the status of an observation.


Fixed Value: final
... category 0..* CodeableConcept このObservationを分類するコード
Binding: JP Core Simple Observation Category ValueSet (preferred)
... code Σ 1..1 CodeableConcept このObservationの対象を特定するコード
Binding: LOINCCodes (example): 単純な観測の名前を識別するコード。 / Codes identifying names of simple observations.

... subject Σ 1..1 Reference(SEAMAT Common Patient Profile) このObservationの対象となる患者や患者群、機器、場所に関する情報
... focus Σ 0..* Reference(Resource) 配偶者、親、胎児、ドナーなど、このObservationのsubject要素が実際の対象でない場合、その実際の対象に関する情報
... encounter Σ 0..1 Reference(JP Core Encounter Profile) 診察や入院など、このObservationが実施されるきっかけとなった診療イベントに関する情報
... effective[x] Σ 0..1 取得された結果が臨床的に確定された日時または期間
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant このバージョンのObservationが医療者に提供された日時。通常、結果を確認し検証後に提供される日時
... performer Σ 0..* Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile | CareTeam | JP Core Patient Profile | RelatedPerson) このObservationの責任者/実施者に関する情報
... value[x] SΣC 0..1 取得された結果
.... 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 このObservationのvalue[x]要素に期待される結果が存在しなかった場合、その理由
Binding: DataAbsentReason (extensible): 結果（ balue.value [x]）が欠落している理由を指定するコード。 / Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept 高、低、正常等の結果のカテゴリ分けした評価
Binding: ObservationInterpretationCodes (extensible): 観測の解釈を識別するコード。 / Codes identifying interpretations of observations.


... note 0..* Annotation このObservationに関するコメント
... bodySite 0..1 CodeableConcept 対象となった身体部位
Binding: SNOMEDCTBodyStructures (example): 解剖学的場所を説明するコード。左右性が含まれる場合があります。 / Codes describing anatomical locations. May include laterality.

... method 0..1 CodeableConcept このObservationの実施方法
Binding: ObservationMethods (example): 単純な観測の方法。 / Methods for simple observations.

... specimen 0..1 Reference(Specimen) このObservationに使われた検体/標本に関する情報
... device 0..1 Reference(Device | DeviceMetric) このObservationでデータを得るために使われた測定機器に関する情報
... referenceRange C 0..* BackboneElement 基準範囲との比較による結果の解釈方法のガイダンス
obs-3: 少なくとも低いまたは高またはテキストが必要です / Must have at least a low or a high or text
.... id 0..1 string 要素間参照のための一意のID / 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) このObservationに関連する子リソースに関する情報。このObservationに関連する/属するパネル検査や検査セットなどのObservationグループ
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | JP Core Observation Common Profile | MolecularSequence) このObservationの結果の導出元に関する情報。例えば、画像検査から取得された結果となる場合その導出元となる画像検査結果を示すImagingStudyリソース
... component Σ 0..* BackboneElement 複合的な結果。例えば、血圧測定値ではそれを構成する収縮期および拡張期の値の組み合わせ
.... id 0..1 string 要素間参照のための一意のID / 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): 結果（ balue.value [x]）が欠落している理由を指定するコード。 / 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

doco Documentation for this format

Terminology バインディング

PathConformanceValueSet / CodeURI
Observation.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.identifier:resourceId.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Observation.identifier:resourceId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Observation.identifier:bundleId.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Observation.identifier:bundleId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Observation.statusrequiredFixed Value: final
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredJP_SimpleObservationCategory_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_SimpleObservationCategory_VS
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationリソースが別のリソースに含まれている場合、ネストされたリソースを含めてはなりません / If the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationリソースが別のリソースに含まれている場合、それはリソースの他の場所から参照されるか、含有リソースを参照するものとします / If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationリソースが別のリソースに含まれている場合、meta.versionidまたはmeta.lastupdatedを持たないものとします / If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservation別のリソースにリソースが含まれている場合、セキュリティラベルはありません / If a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationリソースには、堅牢な管理のための叙述(Narative)が必要です / A resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsすべてのFHIR要素には、@valueまたは子供が必要です / All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensions拡張機能または値[x]のいずれかが必要です。両方ではありません。
: extension.exists() != value.exists()
obs-3errorObservation.referenceRange少なくとも低いまたは高またはテキストが必要です / Must have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdatabsentrasonは、観察.value [x]が存在しない場合にのみ存在するものとします / dataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationvisserveration.codeがvisserveration.component.codeと同じ場合、コードに関連付けられている値要素が存在しないでください / If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
observation-metaprofileerrorObservationmeta.profileには、指定したプロファイルのURLの記述が存在しなければならない。
: meta.profile.where($this = 'http://jpfhir.jp/fhir/SEAMAT/StructureDefinition/JP_Observation_SEAMAT').exists()