診療情報提供書FHIR記述仕様 実装ガイド
1.1.6 - release Japan

診療情報提供書FHIR記述仕様 実装ガイド - Local Development build (v1.1.6) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile(リソースプロファイル): JP_Specimen

項目内容
定義URL http://jpfhir.jp/fhir/core/StructureDefinition/JP_Specimen
Version 1.1.6
Name

JP_Specimen

Status Active ( 2023-03-31 )
Copyright

(一社)日本HL7協会、(一社)日本医療情報学会. CC(Creative Commons) BY-ND 4.0

JP-Specimen 暫定プロファイル


Usage:

プロファイル詳細

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

This structure is derived from Specimen

Summary

Must-Support: 1 element

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*Specimen分析のためのサンプル / Sample for analysis
... id Σ0..1idこのアーティファクトの論理ID / Logical id of this artifact
... meta Σ0..1Metaリソースに関するメタデータ / Metadata about the resource
.... id 0..1stringエレメント相互参照のためのユニークID
.... extension 0..*Extension実装によって定義される追加コンテンツ
Slice: Unordered, Open by value:url
.... versionId Σ0..1idバージョン固有の識別子 (Baajon koyū no shikibetsu-shi)
.... lastUpdated SΣ0..1instantリソースのバージョンが最後に変更されたとき
.... source Σ0..1uri「リソースがどこから来たかを特定する」
.... profile Σ0..*canonical(StructureDefinition)このリソースが適合を主張するプロファイル
.... security Σ0..*Codingこのリソースに適用されたセキュリティラベル
Binding: All Security Labels (extensible): 医療プライバシーおよびセキュリティ分類システムからのセキュリティラベル。


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


... implicitRules ?!Σ0..1uriこのコンテンツが作成されたルールのセット / A set of rules under which this content was created
... language 0..1codeリソースコンテンツの言語 / Language of the resource content
Binding: CommonLanguages (preferred): 人間の言語。 / A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1Narrative人間の解釈のためのリソースのテキスト概要 / 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外部識別子 / External Identifier
... accessionIdentifier Σ0..1Identifierラボによって割り当てられた識別子 / Identifier assigned by the lab
... status ?!Σ0..1code利用可能|利用できない|不十分な|エラーに入った / available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): 標本のステータス/可用性を提供するコード。 / Codes providing the status/availability of a specimen.

... type Σ0..1CodeableConcept標本を形成する種類の材料 / Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): 標本のタイプ。 / The type of the specimen.

... subject Σ0..1Reference(Patient | Group | Device | Substance | Location)標本はどこから来たのか。これは、患者からのもの、場所(環境サンプルのソースなど)、または物質またはデバイスのサンプリングからのものです。 / Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime Σ0..1dateTime処理のために標本を受け取った時間 / The time when specimen was received for processing
... parent 0..*Reference(Specimen)この標本が発生した標本 / Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)標本が収集された理由 / Why the specimen was collected
... collection 0..1BackboneElementコレクションの詳細 / Collection details
.... id 0..1string要素間参照のための一意の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
.... collector Σ0..1Reference(Practitioner | PractitionerRole)標本を収集した人 / Who collected the specimen
.... collected[x] Σ0..1収集時間 / Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1Duration標本を収集するのにどれくらい時間がかかったか / How long it took to collect specimen
.... quantity 0..1SimpleQuantity収集された標本の量 / The quantity of specimen collected
.... method 0..1CodeableConceptコレクションを実行するために使用されるテクニック / Technique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): プロシジャー(処置等)の実行に使用される手法。 / The technique that is used to perform the procedure.

.... bodySite 0..1CodeableConcept解剖学的収集サイト / Anatomical collection site
Binding: SNOMEDCTBodyStructures (example): 解剖学的場所を説明するコード。左右性が含まれる場合があります。 / Codes describing anatomical locations. May include laterality.

.... fastingStatus[x] Σ0..1患者が食べ物や飲み物を控えているかどうか、またはどのくらいの期間 / Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): 患者の断食状況を説明するコード。 / Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing 0..*BackboneElementステップの詳細を処理および処理します / Processing and processing step details
.... id 0..1string要素間参照のための一意の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
.... description 0..1stringプロシジャー(処置等)のテキスト説明 / Textual description of procedure
.... procedure 0..1CodeableConcept標本に適用される治療ステップを示します / Indicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example): 標本の処理に使用される手法を示すタイプ。 / Type indicating the technique used to process the specimen.

.... additive 0..*Reference(Substance)処理ステップで使用される材料 / Material used in the processing step
.... time[x] 0..1標本処理の日時 / Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElement標本の直接容器(チューブ/スライドなど) / Direct container of specimen (tube/slide, etc.)
.... id 0..1string要素間参照のための一意の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
.... identifier Σ0..*IdentifierコンテナのID / Id for the container
.... description 0..1stringコンテナのテキスト説明 / Textual description of the container
.... type 0..1CodeableConcept標本に直接関連する容器の種類 / Kind of container directly associated with specimen
Binding: SpecimenContainerType (example): 標本容器の種類。 / Type of specimen container.

.... capacity 0..1SimpleQuantityコンテナボリュームまたはサイズ / Container volume or size
.... specimenQuantity 0..1SimpleQuantity容器内の標本の量 / Quantity of specimen within container
.... additive[x] 0..1コンテナに関連付けられた添加剤 / Additive associated with container
Binding: hl7VS-additivePreservative (example): 標本容器に追加された物質。 / Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition Σ0..*CodeableConcept標本の状態 / State of the specimen
Binding: hl7VS-specimenCondition (extensible): 標本の状態を説明するコード。 / Codes describing the state of the specimen.


... note 0..*Annotationコメント / Comments

doco Documentation for this format

Terminology Bindings

Terminology Bindings

PathConformanceValueSetURI
Specimen.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Specimen.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Specimen.statusrequiredSpecimenStatus
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typeexampleHl7VSSpecimenType
http://terminology.hl7.org/ValueSet/v2-0487
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
http://hl7.org/fhir/ValueSet/specimen-collection-method
from the FHIR Standard
Specimen.collection.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
http://terminology.hl7.org/ValueSet/v2-0916
Specimen.processing.procedureexampleSpecimenProcessingProcedure
http://hl7.org/fhir/ValueSet/specimen-processing-procedure
from the FHIR Standard
Specimen.container.typeexampleSpecimenContainerType
http://hl7.org/fhir/ValueSet/specimen-container-type
from the FHIR Standard
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
http://terminology.hl7.org/ValueSet/v2-0371
Specimen.conditionextensibleHl7VSSpecimenCondition
http://terminology.hl7.org/ValueSet/v2-0493

Constraints

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenリソースが別のリソースに含まれている場合、ネストされたリソースを含めてはなりません / If the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenリソースが別のリソースに含まれている場合、それはリソースの他の場所から参照されるか、含有リソースを参照するものとします / 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-4errorSpecimenリソースが別のリソースに含まれている場合、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-5errorSpecimen別のリソースにリソースが含まれている場合、セキュリティラベルはありません / If a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenリソースには、堅牢な管理のための叙述(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()

This structure is derived from Specimen

Summary

Must-Support: 1 element

Differential View

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*Specimen分析のためのサンプル / Sample for analysis
... id Σ0..1idこのアーティファクトの論理ID / Logical id of this artifact
... meta Σ0..1Metaリソースに関するメタデータ / Metadata about the resource
.... id 0..1stringエレメント相互参照のためのユニークID
.... extension 0..*Extension実装によって定義される追加コンテンツ
Slice: Unordered, Open by value:url
.... versionId Σ0..1idバージョン固有の識別子 (Baajon koyū no shikibetsu-shi)
.... lastUpdated SΣ0..1instantリソースのバージョンが最後に変更されたとき
.... source Σ0..1uri「リソースがどこから来たかを特定する」
.... profile Σ0..*canonical(StructureDefinition)このリソースが適合を主張するプロファイル
.... security Σ0..*Codingこのリソースに適用されたセキュリティラベル
Binding: All Security Labels (extensible): 医療プライバシーおよびセキュリティ分類システムからのセキュリティラベル。


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


... implicitRules ?!Σ0..1uriこのコンテンツが作成されたルールのセット / A set of rules under which this content was created
... language 0..1codeリソースコンテンツの言語 / Language of the resource content
Binding: CommonLanguages (preferred): 人間の言語。 / A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1Narrative人間の解釈のためのリソースのテキスト概要 / 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外部識別子 / External Identifier
... accessionIdentifier Σ0..1Identifierラボによって割り当てられた識別子 / Identifier assigned by the lab
... status ?!Σ0..1code利用可能|利用できない|不十分な|エラーに入った / available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): 標本のステータス/可用性を提供するコード。 / Codes providing the status/availability of a specimen.

... type Σ0..1CodeableConcept標本を形成する種類の材料 / Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): 標本のタイプ。 / The type of the specimen.

... subject Σ0..1Reference(Patient | Group | Device | Substance | Location)標本はどこから来たのか。これは、患者からのもの、場所(環境サンプルのソースなど)、または物質またはデバイスのサンプリングからのものです。 / Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime Σ0..1dateTime処理のために標本を受け取った時間 / The time when specimen was received for processing
... parent 0..*Reference(Specimen)この標本が発生した標本 / Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)標本が収集された理由 / Why the specimen was collected
... collection 0..1BackboneElementコレクションの詳細 / Collection details
.... id 0..1string要素間参照のための一意の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
.... collector Σ0..1Reference(Practitioner | PractitionerRole)標本を収集した人 / Who collected the specimen
.... collected[x] Σ0..1収集時間 / Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1Duration標本を収集するのにどれくらい時間がかかったか / How long it took to collect specimen
.... quantity 0..1SimpleQuantity収集された標本の量 / The quantity of specimen collected
.... method 0..1CodeableConceptコレクションを実行するために使用されるテクニック / Technique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): プロシジャー(処置等)の実行に使用される手法。 / The technique that is used to perform the procedure.

.... bodySite 0..1CodeableConcept解剖学的収集サイト / Anatomical collection site
Binding: SNOMEDCTBodyStructures (example): 解剖学的場所を説明するコード。左右性が含まれる場合があります。 / Codes describing anatomical locations. May include laterality.

.... fastingStatus[x] Σ0..1患者が食べ物や飲み物を控えているかどうか、またはどのくらいの期間 / Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): 患者の断食状況を説明するコード。 / Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing 0..*BackboneElementステップの詳細を処理および処理します / Processing and processing step details
.... id 0..1string要素間参照のための一意の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
.... description 0..1stringプロシジャー(処置等)のテキスト説明 / Textual description of procedure
.... procedure 0..1CodeableConcept標本に適用される治療ステップを示します / Indicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example): 標本の処理に使用される手法を示すタイプ。 / Type indicating the technique used to process the specimen.

.... additive 0..*Reference(Substance)処理ステップで使用される材料 / Material used in the processing step
.... time[x] 0..1標本処理の日時 / Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElement標本の直接容器(チューブ/スライドなど) / Direct container of specimen (tube/slide, etc.)
.... id 0..1string要素間参照のための一意の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
.... identifier Σ0..*IdentifierコンテナのID / Id for the container
.... description 0..1stringコンテナのテキスト説明 / Textual description of the container
.... type 0..1CodeableConcept標本に直接関連する容器の種類 / Kind of container directly associated with specimen
Binding: SpecimenContainerType (example): 標本容器の種類。 / Type of specimen container.

.... capacity 0..1SimpleQuantityコンテナボリュームまたはサイズ / Container volume or size
.... specimenQuantity 0..1SimpleQuantity容器内の標本の量 / Quantity of specimen within container
.... additive[x] 0..1コンテナに関連付けられた添加剤 / Additive associated with container
Binding: hl7VS-additivePreservative (example): 標本容器に追加された物質。 / Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition Σ0..*CodeableConcept標本の状態 / State of the specimen
Binding: hl7VS-specimenCondition (extensible): 標本の状態を説明するコード。 / Codes describing the state of the specimen.


... note 0..*Annotationコメント / Comments

doco Documentation for this format

Terminology Bindings

Terminology Bindings

PathConformanceValueSetURI
Specimen.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Specimen.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Specimen.statusrequiredSpecimenStatus
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typeexampleHl7VSSpecimenType
http://terminology.hl7.org/ValueSet/v2-0487
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
http://hl7.org/fhir/ValueSet/specimen-collection-method
from the FHIR Standard
Specimen.collection.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
http://terminology.hl7.org/ValueSet/v2-0916
Specimen.processing.procedureexampleSpecimenProcessingProcedure
http://hl7.org/fhir/ValueSet/specimen-processing-procedure
from the FHIR Standard
Specimen.container.typeexampleSpecimenContainerType
http://hl7.org/fhir/ValueSet/specimen-container-type
from the FHIR Standard
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
http://terminology.hl7.org/ValueSet/v2-0371
Specimen.conditionextensibleHl7VSSpecimenCondition
http://terminology.hl7.org/ValueSet/v2-0493

Constraints

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenリソースが別のリソースに含まれている場合、ネストされたリソースを含めてはなりません / If the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenリソースが別のリソースに含まれている場合、それはリソースの他の場所から参照されるか、含有リソースを参照するものとします / 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-4errorSpecimenリソースが別のリソースに含まれている場合、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-5errorSpecimen別のリソースにリソースが含まれている場合、セキュリティラベルはありません / If a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenリソースには、堅牢な管理のための叙述(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()

 

Other representations of profile: CSV, Excel, Schematron