SEAMAT2FHIR ドラフト版
0.1.1 - draft Japan

Publish Box goes here

Resource Profile: SEAMAT Common Patient Profile

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

JP_Patient_SEAMAT
Title

SEAMAT Common Patient Profile
Status Active ( 2023-11-12 )
Copyright

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

このプロファイルはPatientリソースに対して、SEAMAT共通の患者のデータを送受信するための基礎となる制約と拡張を定めたものである。


Usage:

プロファイル詳細

This structure is derived from JP_Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* JP_Patient 医療サービスを受けている個人または動物に関する情報
patient-metaprofile: meta.profileには、指定したプロファイルのURLの記述が存在しなければならない。
... meta
.... lastUpdated S 1..1 instant リソースのバージョンが最後に変更されたとき
.... profile S 1..* canonical(StructureDefinition) このリソースが適合を主張するプロファイル
... Slices for identifier S 1..* Identifier 患者の識別子【詳細参照】
Slice: Unordered, Open by value:system
.... identifier:resourceId S 1..1 Identifier An identifier for this patient
..... 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 識別子のvalueは一意である必要がある。 【詳細参照】
... active 0..1 boolean この患者の記録が積極的に使用されているかどうか / Whether this patient's record is in active use
Fixed Value: true
... name 0..* JP_HumanName 患者に関連付けられた名前 / A name associated with the patient
... telecom 0..* ContactPoint 個人に連絡するための連絡先の詳細
... gender 0..1 code 男性|女性|その他|わからない / male | female | other | unknown
... birthDate 0..1 date 個人の生年月日
... deceased[x] 0..0
... address 0..* Address 個人の住所 【詳細参照】
... maritalStatus 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact
.... relationship 0..0
.... name 0..0
.... telecom 0..0
.... gender 0..0
.... organization 0..1 Reference(SEAMAT Common Department Organization Profile) 連絡先に関連する組織 / Organization that is associated with the contact
.... period 0..0
... link 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* JP_Patient 医療サービスを受けている個人または動物に関する情報
patient-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
... Slices for extension 0..* Extension 実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
.... religion 0..* CodeableConcept 患者の宗教 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... birthPlace 0..1 Address 患者の生誕地 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... race 0..* CodeableConcept 患者の人種 【詳細参照】
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Patient_Race
Binding: Race (preferred)
... modifierExtension ?! 0..* Extension 無視できない拡張機能 / Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier 患者の識別子【詳細参照】
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... 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 識別子の種別 【詳細参照】
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 Σ 0..1 uri The namespace for the identifier value 【詳細参照】
Example Jp: urn:oid:1.2.392.100495.20.3.51.11312345670
..... value Σ 1..1 string 識別子のvalueは一意である必要がある。 【詳細参照】
..... period Σ 0..1 Period IDが使用に有効だった時間期間 / Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(JP Core Organization Profile) IDを発行した組織（単なるテキストである可能性があります） / Organization that issued id (may be just text)
.... identifier:resourceId SΣ 1..1 Identifier An identifier for this patient
..... 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 識別子の種別 【詳細参照】
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 識別子のvalueは一意である必要がある。 【詳細参照】
..... period Σ 0..1 Period IDが使用に有効だった時間期間 / Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(JP Core Organization Profile) IDを発行した組織（単なるテキストである可能性があります） / Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean この患者の記録が積極的に使用されているかどうか / Whether this patient's record is in active use
Fixed Value: true
... name Σ 0..* JP_HumanName 患者に関連付けられた名前 / A name associated with the patient
... telecom Σ 0..* ContactPoint 個人に連絡するための連絡先の詳細
.... id 0..1 string エレメント相互参照のためのユニークID
.... extension 0..* Extension 実装によって定義される追加コンテンツ
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other 【詳細参照】
Binding: ContactPointSystem (required): 連絡先のための通信フォーム。

.... value Σ 0..1 string 実際の連絡先の詳細
.... use ?!Σ 0..1 code home | work | temp | old | mobile - 連絡先の用途等 【詳細参照】
Binding: ContactPointUse (required): 「接点の使用。」(Setten no shiyō.)

.... rank Σ 0..1 positiveInt 使用の優先順位を指定してください（1が最も優先度が高い）
.... period Σ 0..1 Period コンタクトポイントが使用されている時間帯
... gender Σ 0..1 code 男性|女性|その他|わからない / male | female | other | unknown
Binding: AdministrativeGender (required): 管理目的で使用される人の性別。 / The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date 個人の生年月日
... address Σ 0..* Address 個人の住所 【詳細参照】
.... 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 home | work | temp | old | billing - purpose of this address　住所の用途 【詳細参照】
Binding: AddressUse (required): アドレスの使用。 / The use of an address.

.... type Σ 0..1 code postal | physical | both 【詳細参照】
Binding: AddressType (required): アドレスのタイプ（物理 /郵便）。 / The type of an address (physical / postal).

.... text Σ 0..1 string 住所のテキスト表現 【詳細参照】
.... line Σ 0..* string ストリート名や番地など 【詳細参照】
This repeating element order: The order in which lines should appear in an address label
.... city Σ 0..1 string 市区町村名 【詳細参照】
.... district Σ 0..1 string 地区名 【詳細参照】
.... state Σ 0..1 string 国の次の地区単位 【詳細参照】
.... postalCode Σ 0..1 string 郵便番号 【詳細参照】
.... country Σ 0..1 string 国名またはISO 3166コード　(ISO 3166 2 or 3文字こーど)
.... period Σ 0..1 Period 住所が使用されていた（いる）期間
... contact C 0..* BackboneElement 患者の連絡先者（例：保護者、パートナー、友人）
pat-1: 少なくとも連絡先の詳細または組織への参照を含めるものとする / SHALL at least contain a contact's details or a reference to an organization
.... 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
.... address 0..1 Address 連絡先の住所 / Address for the contact person
.... organization C 0..1 Reference(SEAMAT Common Department Organization Profile) 連絡先に関連する組織 / Organization that is associated with the contact
... communication 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
.... language 1..1 CodeableConcept 健康について患者と会話する際に使用する言語。 【詳細参照】
Binding: CommonLanguages (preferred): 人間の言語。 / A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean 言語選好インジケーター / Language preference indicator
... generalPractitioner 0..* Reference(JP Core Organization Profile | JP Core Practitioner Profile | JP Core PractitionerRole Profile) 患者が指名するケア提供者
... managingOrganization Σ 0..1 Reference(JP Core Organization Profile) 患者記録の管理者である組織

doco Documentation for this format

Terminology バインディング

PathConformanceValueSetURI
Patient.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Patient.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:resourceId.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:resourceId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientリソースが別のリソースに含まれている場合、ネストされたリソースを含めてはなりません / If the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientリソースが別のリソースに含まれている場合、それはリソースの他の場所から参照されるか、含有リソースを参照するものとします / 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-4errorPatientリソースが別のリソースに含まれている場合、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-5errorPatient別のリソースにリソースが含まれている場合、セキュリティラベルはありません / If a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientリソースには、堅牢な管理のための叙述(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()
pat-1errorPatient.contact少なくとも連絡先の詳細または組織への参照を含めるものとする / SHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()
patient-metaprofileerrorPatientmeta.profileには、指定したプロファイルのURLの記述が存在しなければならない。
: meta.profile.where($this = 'http://jpfhir.jp/fhir/SEAMAT/StructureDefinition/JP_Patient_SEAMAT').exists()