SEAMAT2FHIR ドラフト版
0.1.1 - draft Japan

Publish Box goes here

Resource Profile: SEAMAT Common DocumentReference Profile

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

JP_DocumentReference_SEAMAT
Title

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

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

このプロファイルはDocumentReferenceリソースに対して、SEAMAT共通の外部参照のドキュメントデータを送受信するための共通の制約と拡張を定めたものである。


Usage:

プロファイル詳細

This structure is derived from JP_DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* JP_DocumentReference ドキュメントへの参照 / A reference to a document
documentreference-metaprofile: meta.profileには、指定したプロファイルのURLの記述が存在しなければならない。
... meta
.... lastUpdated 1..1 instant リソースのバージョンが最後に変更されたとき
.... profile S 1..* canonical(StructureDefinition) このリソースが適合を主張するプロファイル
... masterIdentifier 0..0
... Slices for identifier S 0..* Identifier ドキュメントの他の識別子 / Other identifiers for the document
Slice: Unordered, Open by value:system
.... identifier:resourceId S 0..1 Identifier ドキュメントの他の識別子 / Other identifiers for the document
..... 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
... status 1..1 code 電流|スーパー付き|エラーに入った / current | superseded | entered-in-error
Fixed Value: current
... docStatus 0..1 code 予備|ファイナル|修正|エラーに入った / preliminary | final | amended | entered-in-error
Fixed Value: final
... type S 0..1 CodeableConcept ドキュメントの種類（可能であれば泡） / Kind of document (LOINC if possible)
... subject 0..1 Reference(SEAMAT Common Patient Profile) 誰/文書の主題は何ですか / Who/what is the subject of the document
... content
.... attachment
..... contentType S 0..1 code コンテンツのMIMEタイプ、文字セットなど。
..... data S 1..1 base64Binary データインライン、Base64化された
..... url S 0..1 url データが見つかる場所の売り手 (Data ga mitsukaru basho no urite)
..... hash S 0..1 base64Binary データのハッシュ（sha-1、base64化）
.... format S 0..1 Coding ドキュメントのフォーマット/コンテンツルール / Format/content rules for the document

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* JP_DocumentReference ドキュメントへの参照 / A reference to a document
documentreference-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 「リソースがどこから来たかを特定する」(Risōsu ga doko kara kita ka o tokutei suru)
.... 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Σ 0..* Identifier ドキュメントの他の識別子 / Other identifiers for the document
Slice: Unordered, Open by value:system
.... identifier:resourceId SΣ 0..1 Identifier ドキュメントの他の識別子 / Other identifiers for the document
..... 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)
... status ?!Σ 1..1 code 電流|スーパー付き|エラーに入った / current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): ドキュメント参照のステータス。 / The status of the document reference.


Fixed Value: current
... docStatus Σ 0..1 code 予備|ファイナル|修正|エラーに入った / preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): 基礎となる文書のステータス。 / Status of the underlying document.


Fixed Value: final
... type SΣ 0..1 CodeableConcept ドキュメントの種類（可能であれば泡） / Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): 正確なタイプの臨床文書。 / Precise type of clinical document.

... category Σ 0..* CodeableConcept ドキュメントの分類 / Categorization of document
Binding: DocumentClassValueSet (example): マクロレベルでの高レベルの臨床文書。 / High-level kind of a clinical document at a macro level.


... subject Σ 0..1 Reference(SEAMAT Common Patient Profile) 誰/文書の主題は何ですか / Who/what is the subject of the document
... date Σ 0..1 instant このドキュメント参照が作成されたとき / When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) 誰と/または何が文書を作成したか / Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) 誰/何がドキュメントを認証したのか / Who/what authenticated the document
... custodian 0..1 Reference(Organization) ドキュメントを維持する組織 / Organization which maintains the document
... relatesTo Σ 0..* BackboneElement 他のドキュメントとの関係 / Relationships to other documents
.... 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 code 交換|変換|サイン|追加 / replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): ドキュメント間の関係のタイプ。 / The type of relationship between documents.

.... target Σ 1..1 Reference(DocumentReference) 関係のターゲット / Target of the relationship
... description Σ 0..1 string 人間読み取り可能な説明 / Human-readable description
... securityLabel Σ 0..* CodeableConcept ドキュメントセキュリティタグ / Document security-tags
Binding: All Security Labels (extensible): ヘルスケアプライバシーとセキュリティ分類システムからのセキュリティラベル。 / Security Labels from the Healthcare Privacy and Security Classification System.


... content Σ 1..* BackboneElement 参照されたドキュメント / Document referenced
.... 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
.... attachment Σ 1..1 Attachment ドキュメントにアクセスする場所 / Where to access the document
..... id 0..1 string エレメント相互参照のためのユニークID
..... extension 0..* Extension 実装によって定義される追加コンテンツ
Slice: Unordered, Open by value:url
..... contentType SΣ 0..1 code コンテンツのMIMEタイプ、文字セットなど。
Binding: Mime Types (required): 添付ファイルのMIMEタイプ。有効なMIMEタイプはすべて許可されています。


Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code コンテンツの人間の言語（BCP-47）
Binding: CommonLanguages (preferred): 「人間の言語。」

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data S 1..1 base64Binary データインライン、Base64化された
..... url SΣ 0..1 url データが見つかる場所の売り手 (Data ga mitsukaru basho no urite)
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt コンテンツのバイト数（URLが提供された場合）
..... hash SΣ 0..1 base64Binary データのハッシュ（sha-1、base64化）
..... title Σ 0..1 string データの代わりに表示するラベル
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime 日付の添付ファイルが最初に作成された
.... format SΣ 0..1 Coding ドキュメントのフォーマット/コンテンツルール / Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): ドキュメント形式コード。 / Document Format Codes.

... context Σ 0..1 BackboneElement 文書の臨床コンテキスト / Clinical context of document
.... 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
.... encounter 0..* Reference(Encounter | EpisodeOfCare) ドキュメントコンテンツのコンテキスト / Context of the document content
.... event 0..* CodeableConcept 主な臨床行為が文書化されています / Main clinical acts documented
Binding: v3 Code System ActCode (example): このコードのリストは、文書化されている主要な臨床行為を表しています。 / This list of codes represents the main clinical acts being documented.


.... period Σ 0..1 Period 文書化されているサービス時間 / Time of service that is being documented
.... facilityType 0..1 CodeableConcept 患者が見られたような施設 / Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS施設タイプ。 / XDS Facility Type.

.... practiceSetting 0..1 CodeableConcept コンテンツが作成された場所に関する追加の詳細（臨床専門分野など） / Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): コンテンツが作成された場所に関する追加の詳細（臨床専門分野など）。 / Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo 0..1 Reference(Patient) ソースからの患者の人口統計 / Patient demographics from source
.... related 0..* Reference(Resource) 関連する識別子またはリソース / Related identifiers or resources

doco Documentation for this format

Terminology バインディング

PathConformanceValueSet / CodeURI
DocumentReference.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.identifier:resourceId.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.identifier:resourceId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DocumentReference.statusrequiredFixed Value: current
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredFixed Value: final
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
DocumentReference.typepreferredDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMime Types
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes
from the FHIR Standard
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
documentreference-metaprofileerrorDocumentReferencemeta.profileには、指定したプロファイルのURLの記述が存在しなければならない。
: meta.profile.where($this = 'http://jpfhir.jp/fhir/SEAMAT/StructureDefinition/JP_DocumentReference_SEAMAT').exists()
dom-2errorDocumentReferenceリソースが別のリソースに含まれている場合、ネストされたリソースを含めてはなりません / If the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceリソースが別のリソースに含まれている場合、それはリソースの他の場所から参照されるか、含有リソースを参照するものとします / 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-4errorDocumentReferenceリソースが別のリソースに含まれている場合、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-5errorDocumentReference別のリソースにリソースが含まれている場合、セキュリティラベルはありません / If a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceリソースには、堅牢な管理のための叙述(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()