電子カルテ情報共有サービス2文書5情報+患者サマリー FHIR実装ガイド JP-CLINS(CLinical Information Sharing ImplementationGuide) v1.5.5
1.5.5 - release
Japan
項目 | 内容 |
定義URL | http://jpfhir.jp/fhir/eCS/StructureDefinition/JP_DocumentReference_CDAdocument |
Version | 1.5.5 |
Name | JP_DocumentReference_CDAdocument |
Status | Active ( 2024-09-14 ) |
Copyright | (一社)日本医療情報学会. CC BY-ND 4.0 |
Derived Profile from JP-Core
Usage:
This structure is derived from JP_DocumentReference
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | JP_DocumentReference | ドキュメントへの参照 / A reference to a document | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | 0..* | JP_DocumentReference | ドキュメントへの参照 / A reference to a document | |||||
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 | バージョン固有の識別子 | ||||
lastUpdated | SΣ | 0..1 | instant | 「リソースのバージョンが最後に変更されたとき」 | ||||
source | Σ | 0..1 | uri | 「リソースがどこから来たかを特定する」 | ||||
profile | Σ | 0..* | 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.
| |||||
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 | ||||
masterIdentifier | Σ | 0..1 | Identifier | マスターバージョン固有の識別子 / Master Version Specific Identifier | ||||
identifier | Σ | 0..* | Identifier | ドキュメントの他の識別子 / Other identifiers for the document | ||||
status | ?!Σ | 1..1 | code | 電流|スーパー付き|エラーに入った / current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): ドキュメント参照のステータス。 / The status of the document reference. | ||||
docStatus | Σ | 0..1 | code | 予備|ファイナル|修正|エラーに入った / preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): 基礎となる文書のステータス。 / Status of the underlying document. | ||||
type | Σ | 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(Patient | Practitioner | Group | Device) | 誰/文書の主題は何ですか / 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 | ||||
format | Σ | 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 | |||||
Documentation for this format |
Terminology バインディング
Path | Conformance | ValueSet | URI | |||
DocumentReference.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DocumentReference.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DocumentReference.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard | ||||
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
DocumentReference.type | preferred | DocumentTypeValueSethttp://hl7.org/fhir/ValueSet/c80-doc-typecodes from the FHIR Standard | ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard |
Constraints
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | リソースが別のリソースに含まれている場合、ネストされたリソースを含めてはなりません / If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | リソースが別のリソースに含まれている場合、それはリソースの他の場所から参照されるか、含有リソースを参照するものとします / 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-4 | error | DocumentReference | リソースが別のリソースに含まれている場合、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-5 | error | DocumentReference | 別のリソースにリソースが含まれている場合、セキュリティラベルはありません / If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | リソースには、堅牢な管理のための叙述(Narative)が必要です / A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | すべてのFHIR要素には、@valueまたは子供が必要です / All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 「拡張機能または値[x]のいずれかが必要です。両方ではありません。」 : extension.exists() != value.exists() |