診療情報提供書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_DocumentReference

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

JP_DocumentReference
Status Active ( 2023-03-31 )
Copyright

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

JP_DocumentReference　暫定プロファイル


Usage:

プロファイル詳細

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

This structure is derived from DocumentReference

Summary

Must-Support: 1 element

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceドキュメントへの参照 / A reference to a document
... 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
... masterIdentifier Σ0..1Identifierマスターバージョン固有の識別子 / Master Version Specific Identifier
... identifier Σ0..*Identifierドキュメントの他の識別子 / Other identifiers for the document
... status ?!Σ1..1code電流|スーパー付き|エラーに入った / current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): ドキュメント参照のステータス。 / The status of the document reference.

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

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

.... target Σ1..1Reference(DocumentReference)関係のターゲット / Target of the relationship
... description Σ0..1string人間読み取り可能な説明 / 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..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
.... attachment Σ1..1Attachmentドキュメントにアクセスする場所 / Where to access the document
.... format Σ0..1Codingドキュメントのフォーマット/コンテンツルール / Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): ドキュメント形式コード。 / Document Format Codes.

... context Σ0..1BackboneElement文書の臨床コンテキスト / Clinical context of document
.... 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
.... 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..1Period文書化されているサービス時間 / Time of service that is being documented
.... facilityType 0..1CodeableConcept患者が見られたような施設 / Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS施設タイプ。 / XDS Facility Type.

.... practiceSetting 0..1CodeableConceptコンテンツが作成された場所に関する追加の詳細（臨床専門分野など） / 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..1Reference(Patient)ソースからの患者の人口統計 / Patient demographics from source
.... related 0..*Reference(Resource)関連する識別子またはリソース / Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Terminology Bindings

PathConformanceValueSetURI
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.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
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.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

Constraints

IdGradePath(s)DetailsRequirements
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()

This structure is derived from DocumentReference

Summary

Must-Support: 1 element

Differential View

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceドキュメントへの参照 / A reference to a document
... 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
... masterIdentifier Σ0..1Identifierマスターバージョン固有の識別子 / Master Version Specific Identifier
... identifier Σ0..*Identifierドキュメントの他の識別子 / Other identifiers for the document
... status ?!Σ1..1code電流|スーパー付き|エラーに入った / current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): ドキュメント参照のステータス。 / The status of the document reference.

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

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

.... target Σ1..1Reference(DocumentReference)関係のターゲット / Target of the relationship
... description Σ0..1string人間読み取り可能な説明 / 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..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
.... attachment Σ1..1Attachmentドキュメントにアクセスする場所 / Where to access the document
.... format Σ0..1Codingドキュメントのフォーマット/コンテンツルール / Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): ドキュメント形式コード。 / Document Format Codes.

... context Σ0..1BackboneElement文書の臨床コンテキスト / Clinical context of document
.... 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
.... 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..1Period文書化されているサービス時間 / Time of service that is being documented
.... facilityType 0..1CodeableConcept患者が見られたような施設 / Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS施設タイプ。 / XDS Facility Type.

.... practiceSetting 0..1CodeableConceptコンテンツが作成された場所に関する追加の詳細（臨床専門分野など） / 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..1Reference(Patient)ソースからの患者の人口統計 / Patient demographics from source
.... related 0..*Reference(Resource)関連する識別子またはリソース / Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Terminology Bindings

PathConformanceValueSetURI
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.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
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.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

Constraints

IdGradePath(s)DetailsRequirements
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()

 

Other representations of profile: CSV, Excel, Schematron