HL7 FHIR JP Core ImplementationGuide
2.0.0-dev - ci-build Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v2.0.0-dev) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: JP Core Patient Profile

項目内容
定義URL http://jpfhir.jp/fhir/core/StructureDefinition/JP_Patient
Version 2.0.0-dev
Name

JP_Patient
Title

JP Core Patient Profile
Status Active ( 2023-10-31 )
Copyright

Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG

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

患者のケアやその他の健康関連サービスを受けている個人または動物に関する人口統計およびその他の管理情報。

スコープ

本リソースは、以下を含む幅広い健康関連活動に関与する患者と動物に関するデータをカバーしている。

  • 治療
  • 精神科医療
  • 社会福祉
  • 妊娠ケア
  • 看護と生活支援
  • 健康サービス
  • 個人の健康と運動データの追跡

本リソースのデータは、患者個人に関する情報をカバーしている。その属性は、管理、財務、およびロジスティックな手続きをサポートするために必要な人口統計学的情報に焦点を当てている。患者の記録は、通常、患者のケアを行う各組織によって作成・維持される。従って、複数の組織で治療を受けている患者又は動物は、その情報を複数のPatientリソースに存在させることができる。

全ての概念が基本リソースに含まれているわけではないが(人種、民族、臓器提供の有無、国籍等)、特定の法域のために定義されたプロファイルや標準的な拡張機能に含まれている場合がある。このようなフィールドは、法域によって大きく異なり、似たような概念でも名前や値セットが異なることが多いが、マッピングや交換ができるほど似ているわけではない。

本プロファイルは、患者に関する情報の登録や検索、取得のために 、FHIR Patientリソースを使用するにあたっての、最低限の制約を記述したものである。Patientリソースに対して本プロファイルに準拠する場合に必須となる要素や、サポートすべき拡張、用語、検索パラメータを定義する。

背景および想定シナリオ

本プロファイルは、以下のようなユースケースを想定している。

  • 氏名などの患者情報による患者基本情報の検索

  • 他のリソースからの患者基本情報の参照

プロファイル定義

Usage:

プロファイル詳細

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient 医療サービスを受けている個人または動物に関する情報
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:religion 0..* CodeableConcept 患者の宗教 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:birthPlace 0..1 Address 患者の生誕地 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension:race 0..* CodeableConcept 患者の人種 【詳細参照】
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Patient_Race
Binding: Race (preferred)
... identifier 1..* Identifier 患者の識別子【詳細参照】
.... use 0..1 code usual | official | temp | secondary | old (If known) 【詳細参照】
.... type 0..1 CodeableConcept 識別子の種別 【詳細参照】
.... system 0..1 uri The namespace for the identifier value 【詳細参照】
.... value 1..1 string 識別子のvalueは一意である必要がある。 【詳細参照】
.... period 0..1 Period Time period when id is/was valid for use
.... assigner 0..1 Reference(JP Core Organization Profile) Organization that issued id (may be just text)
... active 0..1 boolean Whether this patient's record is in active use
... name 0..* JP_HumanName A name associated with the patient
... telecom 0..* ContactPoint 個人に連絡するための連絡先の詳細
.... system 0..1 code phone | fax | email | pager | url | sms | other 【詳細参照】
.... value 0..1 string The actual contact point details
.... use 0..1 code home | work | temp | old | mobile - 連絡先の用途等 【詳細参照】
.... rank 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period 0..1 Period Time period when the contact point was/is in use
... gender 0..1 code male | female | other | unknown
... birthDate 0..1 date 個人の生年月日
... deceased[x] 0..1 boolean, dateTime 個人が死亡しているかどうかを示す
... address 0..* Address 個人の住所 【詳細参照】
.... use 0..1 code home | work | temp | old | billing - purpose of this address　住所の用途 【詳細参照】
.... type 0..1 code postal | physical | both 【詳細参照】
.... text 0..1 string 住所のテキスト表現 【詳細参照】
.... line 0..* string ストリート名や番地など 【詳細参照】
.... 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 住所が使用されていた（いる）期間
... maritalStatus 0..1 CodeableConcept 患者の婚姻（市民）状態 【詳細参照】
... multipleBirth[x] 0..1 boolean, integer 患者が多胎出産の一人かどうか
... photo 0..* Attachment 患者の画像
... contact 0..* BackboneElement 患者の連絡先者（例：保護者、パートナー、友人）
.... relationship 0..* CodeableConcept 関係性の種類 【詳細参照】
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
.... organization 0..1 Reference(JP Core Organization Profile) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement 健康について患者と会話する際に使用する言語
.... language 1..1 CodeableConcept 健康について患者と会話する際に使用する言語。 【詳細参照】
.... 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) 患者記録の管理者である組織
... link 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... other 1..1 Reference(JP Core Patient Profile | RelatedPerson) The other patient or related person resource that the link refers to
.... type 1..1 code replaced-by | replaces | refer | seealso 【詳細参照】

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient 医療サービスを受けている個人または動物に関する情報
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:religion 0..* CodeableConcept 患者の宗教 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:birthPlace 0..1 Address 患者の生誕地 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:race 0..* CodeableConcept 患者の人種 【詳細参照】
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Patient_Race
Binding: Race (preferred)
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 1..* Identifier 患者の識別子【詳細参照】
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known) 【詳細参照】
Binding: IdentifierUse (required)
ele-1: All FHIR elements must have a @value or children
.... type Σ 0..1 CodeableConcept 識別子の種別 【詳細参照】
Binding: Identifier Type Codes (extensible)
ele-1: All FHIR elements must have a @value or children
.... system Σ 0..1 uri The namespace for the identifier value 【詳細参照】
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string 識別子のvalueは一意である必要がある。 【詳細参照】
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
ele-1: All FHIR elements must have a @value or children
.... assigner Σ 0..1 Reference(JP Core Organization Profile) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
ele-1: All FHIR elements must have a @value or children
... name Σ 0..* JP_HumanName A name associated with the patient
ele-1: All FHIR elements must have a @value or children
... telecom Σ 0..* ContactPoint 個人に連絡するための連絡先の詳細
ele-1: All FHIR elements must have a @value or children
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other 【詳細参照】
Binding: ContactPointSystem (required)
ele-1: All FHIR elements must have a @value or children
.... value Σ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - 連絡先の用途等 【詳細参照】
Binding: ContactPointUse (required)
ele-1: All FHIR elements must have a @value or children
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
ele-1: All FHIR elements must have a @value or children
.... period Σ 0..1 Period Time period when the contact point was/is in use
ele-1: All FHIR elements must have a @value or children
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


ele-1: All FHIR elements must have a @value or children
... birthDate Σ 0..1 date 個人の生年月日
ele-1: All FHIR elements must have a @value or children
... deceased[x] ?!Σ 0..1 個人が死亡しているかどうかを示す
ele-1: All FHIR elements must have a @value or children
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address 個人の住所 【詳細参照】
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address　住所の用途 【詳細参照】
Binding: AddressUse (required): The use of an address (home / work / etc.).


ele-1: All FHIR elements must have a @value or children
Example General: home
.... type Σ 0..1 code postal | physical | both 【詳細参照】
Binding: AddressType (required): The type of an address (physical / postal).


ele-1: All FHIR elements must have a @value or children
Example General: both
.... text Σ 0..1 string 住所のテキスト表現 【詳細参照】
ele-1: All FHIR elements must have a @value or children
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string ストリート名や番地など 【詳細参照】
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string 市区町村名 【詳細参照】
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
.... district Σ 0..1 string 地区名 【詳細参照】
ele-1: All FHIR elements must have a @value or children
Example General: Madison
.... state Σ 0..1 string 国の次の地区単位 【詳細参照】
ele-1: All FHIR elements must have a @value or children
.... postalCode Σ 0..1 string 郵便番号 【詳細参照】
ele-1: All FHIR elements must have a @value or children
Example General: 9132
.... country Σ 0..1 string 国名またはISO 3166コード　(ISO 3166 2 or 3文字こーど)
ele-1: All FHIR elements must have a @value or children
.... period Σ 0..1 Period 住所が使用されていた（いる）期間
ele-1: All FHIR elements must have a @value or children
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept 患者の婚姻（市民）状態 【詳細参照】
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.


ele-1: All FHIR elements must have a @value or children
... multipleBirth[x] 0..1 患者が多胎出産の一人かどうか
ele-1: All FHIR elements must have a @value or children
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment 患者の画像
ele-1: All FHIR elements must have a @value or children
... contact C 0..* BackboneElement 患者の連絡先者（例：保護者、パートナー、友人）
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... relationship 0..* CodeableConcept 関係性の種類 【詳細参照】
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


ele-1: All FHIR elements must have a @value or children
.... name 0..1 HumanName A name associated with the contact person
ele-1: All FHIR elements must have a @value or children
.... telecom 0..* ContactPoint A contact detail for the person
ele-1: All FHIR elements must have a @value or children
.... address 0..1 Address Address for the contact person
ele-1: All FHIR elements must have a @value or children
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


ele-1: All FHIR elements must have a @value or children
.... organization C 0..1 Reference(JP Core Organization Profile) Organization that is associated with the contact
ele-1: All FHIR elements must have a @value or children
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
ele-1: All FHIR elements must have a @value or children
... communication 0..* BackboneElement 健康について患者と会話する際に使用する言語
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... language 1..1 CodeableConcept 健康について患者と会話する際に使用する言語。 【詳細参照】
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

ele-1: All FHIR elements must have a @value or children
.... preferred 0..1 boolean Language preference indicator
ele-1: All FHIR elements must have a @value or children
... generalPractitioner 0..* Reference(JP Core Organization Profile | JP Core Practitioner Profile | JP Core PractitionerRole Profile) 患者が指名するケア提供者
ele-1: All FHIR elements must have a @value or children
... managingOrganization Σ 0..1 Reference(JP Core Organization Profile) 患者記録の管理者である組織
ele-1: All FHIR elements must have a @value or children
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... other Σ 1..1 Reference(JP Core Patient Profile | RelatedPerson) The other patient or related person resource that the link refers to
ele-1: All FHIR elements must have a @value or children
.... type Σ 1..1 code replaced-by | replaces | refer | seealso 【詳細参照】
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient 医療サービスを受けている個人または動物に関する情報
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:religion 0..* CodeableConcept 患者の宗教 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:birthPlace 0..1 Address 患者の生誕地 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension: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
... identifier Σ 1..* Identifier 患者の識別子【詳細参照】
.... id 0..1 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)
.... type Σ 0..1 CodeableConcept 識別子の種別 【詳細参照】
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value 【詳細参照】
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string 識別子のvalueは一意である必要がある。 【詳細参照】
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(JP Core Organization Profile) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* JP_HumanName A name associated with the patient
... telecom Σ 0..* ContactPoint 個人に連絡するための連絡先の詳細
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
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 The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - 連絡先の用途等 【詳細参照】
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date 個人の生年月日
... deceased[x] ?!Σ 0..1 個人が死亡しているかどうかを示す
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address 個人の住所 【詳細参照】
.... id 0..1 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 (home / work / etc.).


Example General: home
.... type Σ 0..1 code postal | physical | both 【詳細参照】
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string 住所のテキスト表現 【詳細参照】
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string ストリート名や番地など 【詳細参照】
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string 市区町村名 【詳細参照】
Example General: Erewhon
.... district Σ 0..1 string 地区名 【詳細参照】
Example General: Madison
.... state Σ 0..1 string 国の次の地区単位 【詳細参照】
.... postalCode Σ 0..1 string 郵便番号 【詳細参照】
Example General: 9132
.... country Σ 0..1 string 国名またはISO 3166コード　(ISO 3166 2 or 3文字こーど)
.... period Σ 0..1 Period 住所が使用されていた（いる）期間
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept 患者の婚姻（市民）状態 【詳細参照】
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 患者が多胎出産の一人かどうか
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment 患者の画像
... contact C 0..* BackboneElement 患者の連絡先者（例：保護者、パートナー、友人）
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string 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
.... relationship 0..* CodeableConcept 関係性の種類 【詳細参照】
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(JP Core Organization Profile) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement 健康について患者と会話する際に使用する言語
.... id 0..1 string 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): IETF language tag

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) 患者記録の管理者である組織
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string 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
.... other Σ 1..1 Reference(JP Core Patient Profile | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso 【詳細参照】
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
from the FHIR Standard
Patient.identifier.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.3.0
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.3.0
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.3.0
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.3.0
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.3.0
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.3.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningPatient.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient 医療サービスを受けている個人または動物に関する情報
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:religion 0..* CodeableConcept 患者の宗教 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:birthPlace 0..1 Address 患者の生誕地 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension:race 0..* CodeableConcept 患者の人種 【詳細参照】
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Patient_Race
Binding: Race (preferred)
... identifier 1..* Identifier 患者の識別子【詳細参照】
.... use 0..1 code usual | official | temp | secondary | old (If known) 【詳細参照】
.... type 0..1 CodeableConcept 識別子の種別 【詳細参照】
.... system 0..1 uri The namespace for the identifier value 【詳細参照】
.... value 1..1 string 識別子のvalueは一意である必要がある。 【詳細参照】
.... period 0..1 Period Time period when id is/was valid for use
.... assigner 0..1 Reference(JP Core Organization Profile) Organization that issued id (may be just text)
... active 0..1 boolean Whether this patient's record is in active use
... name 0..* JP_HumanName A name associated with the patient
... telecom 0..* ContactPoint 個人に連絡するための連絡先の詳細
.... system 0..1 code phone | fax | email | pager | url | sms | other 【詳細参照】
.... value 0..1 string The actual contact point details
.... use 0..1 code home | work | temp | old | mobile - 連絡先の用途等 【詳細参照】
.... rank 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period 0..1 Period Time period when the contact point was/is in use
... gender 0..1 code male | female | other | unknown
... birthDate 0..1 date 個人の生年月日
... deceased[x] 0..1 boolean, dateTime 個人が死亡しているかどうかを示す
... address 0..* Address 個人の住所 【詳細参照】
.... use 0..1 code home | work | temp | old | billing - purpose of this address　住所の用途 【詳細参照】
.... type 0..1 code postal | physical | both 【詳細参照】
.... text 0..1 string 住所のテキスト表現 【詳細参照】
.... line 0..* string ストリート名や番地など 【詳細参照】
.... 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 住所が使用されていた（いる）期間
... maritalStatus 0..1 CodeableConcept 患者の婚姻（市民）状態 【詳細参照】
... multipleBirth[x] 0..1 boolean, integer 患者が多胎出産の一人かどうか
... photo 0..* Attachment 患者の画像
... contact 0..* BackboneElement 患者の連絡先者（例：保護者、パートナー、友人）
.... relationship 0..* CodeableConcept 関係性の種類 【詳細参照】
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
.... organization 0..1 Reference(JP Core Organization Profile) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement 健康について患者と会話する際に使用する言語
.... language 1..1 CodeableConcept 健康について患者と会話する際に使用する言語。 【詳細参照】
.... 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) 患者記録の管理者である組織
... link 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... other 1..1 Reference(JP Core Patient Profile | RelatedPerson) The other patient or related person resource that the link refers to
.... type 1..1 code replaced-by | replaces | refer | seealso 【詳細参照】

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient 医療サービスを受けている個人または動物に関する情報
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:religion 0..* CodeableConcept 患者の宗教 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:birthPlace 0..1 Address 患者の生誕地 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:race 0..* CodeableConcept 患者の人種 【詳細参照】
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Patient_Race
Binding: Race (preferred)
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 1..* Identifier 患者の識別子【詳細参照】
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known) 【詳細参照】
Binding: IdentifierUse (required)
ele-1: All FHIR elements must have a @value or children
.... type Σ 0..1 CodeableConcept 識別子の種別 【詳細参照】
Binding: Identifier Type Codes (extensible)
ele-1: All FHIR elements must have a @value or children
.... system Σ 0..1 uri The namespace for the identifier value 【詳細参照】
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string 識別子のvalueは一意である必要がある。 【詳細参照】
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
ele-1: All FHIR elements must have a @value or children
.... assigner Σ 0..1 Reference(JP Core Organization Profile) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
ele-1: All FHIR elements must have a @value or children
... name Σ 0..* JP_HumanName A name associated with the patient
ele-1: All FHIR elements must have a @value or children
... telecom Σ 0..* ContactPoint 個人に連絡するための連絡先の詳細
ele-1: All FHIR elements must have a @value or children
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other 【詳細参照】
Binding: ContactPointSystem (required)
ele-1: All FHIR elements must have a @value or children
.... value Σ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - 連絡先の用途等 【詳細参照】
Binding: ContactPointUse (required)
ele-1: All FHIR elements must have a @value or children
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
ele-1: All FHIR elements must have a @value or children
.... period Σ 0..1 Period Time period when the contact point was/is in use
ele-1: All FHIR elements must have a @value or children
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


ele-1: All FHIR elements must have a @value or children
... birthDate Σ 0..1 date 個人の生年月日
ele-1: All FHIR elements must have a @value or children
... deceased[x] ?!Σ 0..1 個人が死亡しているかどうかを示す
ele-1: All FHIR elements must have a @value or children
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address 個人の住所 【詳細参照】
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address　住所の用途 【詳細参照】
Binding: AddressUse (required): The use of an address (home / work / etc.).


ele-1: All FHIR elements must have a @value or children
Example General: home
.... type Σ 0..1 code postal | physical | both 【詳細参照】
Binding: AddressType (required): The type of an address (physical / postal).


ele-1: All FHIR elements must have a @value or children
Example General: both
.... text Σ 0..1 string 住所のテキスト表現 【詳細参照】
ele-1: All FHIR elements must have a @value or children
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string ストリート名や番地など 【詳細参照】
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string 市区町村名 【詳細参照】
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
.... district Σ 0..1 string 地区名 【詳細参照】
ele-1: All FHIR elements must have a @value or children
Example General: Madison
.... state Σ 0..1 string 国の次の地区単位 【詳細参照】
ele-1: All FHIR elements must have a @value or children
.... postalCode Σ 0..1 string 郵便番号 【詳細参照】
ele-1: All FHIR elements must have a @value or children
Example General: 9132
.... country Σ 0..1 string 国名またはISO 3166コード　(ISO 3166 2 or 3文字こーど)
ele-1: All FHIR elements must have a @value or children
.... period Σ 0..1 Period 住所が使用されていた（いる）期間
ele-1: All FHIR elements must have a @value or children
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept 患者の婚姻（市民）状態 【詳細参照】
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.


ele-1: All FHIR elements must have a @value or children
... multipleBirth[x] 0..1 患者が多胎出産の一人かどうか
ele-1: All FHIR elements must have a @value or children
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment 患者の画像
ele-1: All FHIR elements must have a @value or children
... contact C 0..* BackboneElement 患者の連絡先者（例：保護者、パートナー、友人）
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... relationship 0..* CodeableConcept 関係性の種類 【詳細参照】
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


ele-1: All FHIR elements must have a @value or children
.... name 0..1 HumanName A name associated with the contact person
ele-1: All FHIR elements must have a @value or children
.... telecom 0..* ContactPoint A contact detail for the person
ele-1: All FHIR elements must have a @value or children
.... address 0..1 Address Address for the contact person
ele-1: All FHIR elements must have a @value or children
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


ele-1: All FHIR elements must have a @value or children
.... organization C 0..1 Reference(JP Core Organization Profile) Organization that is associated with the contact
ele-1: All FHIR elements must have a @value or children
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
ele-1: All FHIR elements must have a @value or children
... communication 0..* BackboneElement 健康について患者と会話する際に使用する言語
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... language 1..1 CodeableConcept 健康について患者と会話する際に使用する言語。 【詳細参照】
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

ele-1: All FHIR elements must have a @value or children
.... preferred 0..1 boolean Language preference indicator
ele-1: All FHIR elements must have a @value or children
... generalPractitioner 0..* Reference(JP Core Organization Profile | JP Core Practitioner Profile | JP Core PractitionerRole Profile) 患者が指名するケア提供者
ele-1: All FHIR elements must have a @value or children
... managingOrganization Σ 0..1 Reference(JP Core Organization Profile) 患者記録の管理者である組織
ele-1: All FHIR elements must have a @value or children
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... other Σ 1..1 Reference(JP Core Patient Profile | RelatedPerson) The other patient or related person resource that the link refers to
ele-1: All FHIR elements must have a @value or children
.... type Σ 1..1 code replaced-by | replaces | refer | seealso 【詳細参照】
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient 医療サービスを受けている個人または動物に関する情報
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:religion 0..* CodeableConcept 患者の宗教 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:birthPlace 0..1 Address 患者の生誕地 【詳細参照】
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension: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
... identifier Σ 1..* Identifier 患者の識別子【詳細参照】
.... id 0..1 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)
.... type Σ 0..1 CodeableConcept 識別子の種別 【詳細参照】
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value 【詳細参照】
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string 識別子のvalueは一意である必要がある。 【詳細参照】
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(JP Core Organization Profile) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* JP_HumanName A name associated with the patient
... telecom Σ 0..* ContactPoint 個人に連絡するための連絡先の詳細
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
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 The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - 連絡先の用途等 【詳細参照】
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date 個人の生年月日
... deceased[x] ?!Σ 0..1 個人が死亡しているかどうかを示す
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address 個人の住所 【詳細参照】
.... id 0..1 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 (home / work / etc.).


Example General: home
.... type Σ 0..1 code postal | physical | both 【詳細参照】
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string 住所のテキスト表現 【詳細参照】
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string ストリート名や番地など 【詳細参照】
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string 市区町村名 【詳細参照】
Example General: Erewhon
.... district Σ 0..1 string 地区名 【詳細参照】
Example General: Madison
.... state Σ 0..1 string 国の次の地区単位 【詳細参照】
.... postalCode Σ 0..1 string 郵便番号 【詳細参照】
Example General: 9132
.... country Σ 0..1 string 国名またはISO 3166コード　(ISO 3166 2 or 3文字こーど)
.... period Σ 0..1 Period 住所が使用されていた（いる）期間
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept 患者の婚姻（市民）状態 【詳細参照】
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 患者が多胎出産の一人かどうか
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment 患者の画像
... contact C 0..* BackboneElement 患者の連絡先者（例：保護者、パートナー、友人）
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string 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
.... relationship 0..* CodeableConcept 関係性の種類 【詳細参照】
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(JP Core Organization Profile) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement 健康について患者と会話する際に使用する言語
.... id 0..1 string 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): IETF language tag

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) 患者記録の管理者である組織
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string 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
.... other Σ 1..1 Reference(JP Core Patient Profile | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso 【詳細参照】
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
from the FHIR Standard
Patient.identifier.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.3.0
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.3.0
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.3.0
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.3.0
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.3.0
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.3.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningPatient.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

 

Other representations of profile: CSV, Excel, Schematron

必須要素

Patient リソースは、次の要素を持たなければならない。

  • identifier ：患者を識別するための識別子は必須要素でありidentifier.value が必ず存在しなければならない、またidentifierの名前空間を表すidentifier.systemも組み合わせて、医療機関固有の患者番号を表現することが一般的である

Extensions定義

JP Patient リソースで使用される拡張は次の通りである。

  • religion

    • 患者の宗教を表す

  • birthPlace

    • 患者の生誕地を表す。Address型を使って表現するため、すべての住所情報あるいは、都道府県名のみの情報(Address.state)だけを格納するということも可能である

  • JP_Patient_Race

    • 患者の人種に関する情報を表す

  • nameRepresentationUse

    • 患者氏名(Patient.name)の漢字表記・カナ表記識別のために使用する

利用方法

OperationおよびSearch Parameter 一覧

Search Parameter一覧

コンフォーマンス パラメータ 型 例
SHALL identifier token GET [base]/Patient?identifier=urn:oid:1.2.392.100495.20.3.51.11312345670|123456
SHOULD name string GET [base]/Patient?name=山田%20太郎
SHOULD birthdate,name date,string GET [base]/Patient?birthdate=eq2013-01-14&name=山田%20太郎
SHOULD birthdate,gender date,token GET [base]/Patient?birthdate=eq2013-01-14&gender=male
SHOULD birthdate,name,gender date,string,token GET [base]/Patient?birthdate=eq2013-01-14&name=山田%20太郎&gender=male
SHOULD name,phone string,token GET [base]/Patient?name=山田%20太郎&phone=111-222-3333
SHOULD name,address-postalcode string,string GET [base]/Patient?name=山田%20太郎&address-postalcode=1234567
MAY family,given,birthdate,gender,phone,address-postalcode string,string,date,token,token,string GET [base]/Patient?family=山田&given=太郎&birthdate=eq2013-01-14&gender=male&phone=111-222-3333&address-postalcode=1234567
必須検索パラメータ

次の検索パラメータは必須でサポートされなければならない。

  1. identifier 検索パラメータを使用して、患者番号/カルテ番号などの識別子によるPatientの検索をサポートしなければならない（SHALL）

    GET [base]/Patient?identifier={system|}[token]

    例：

    GET [base]/Patient?identifier=urn:oid:1.2.392.100495.20.3.51.11312345670|123456

    指定された識別子に一致するPatientリソースを含むBundleを検索する。

推奨検索パラメータ

次の検索パラメータをサポートすることが望ましい。

  1. name 検索パラメータを使用してPatientの検索をサポートすることが望ましい（SHOULD）、name検索パラメータはHumanNameの文字列フィールド（family、give、prefix、suffix、および/またはtextを含む）のいずれかに一致するPatientリソースを検索する 
    GET [base]/Patient?name={string}

    例：

    GET [base]/Patient?name=山田%20太郎

  2. birthdate, name 検索パラメータを使用して、Patientの検索をサポートすることが望ましい（SHOULD）。name検索パラメータは、HumanNameの文字列フィールド（family、give、prefix、suffix、および/またはtextを含む）のいずれかに一致するPatientリソースを検索する

    GET [base]/Patient?birthdate=eq{date}&name={string}

    例：

    GET [base]/Patient?birthdate=eq2000-10-10&name=山田%20太郎

  3. birthdate, gender 検索パラメータを使用して、Patientの検索をサポートすることが望ましい（SHOULD）

    GET [base]/Patient?birthdate=eq{date}&gender={token}

    例：

    GET [base]/Patient?birthdate=eq2000-10-10&gender=male

  4. birthdate, name, gender 検索パラメータを使用してPatientの検索をサポートすることが望ましい（SHOULD）、name検索パラメータはHumanNameの文字列フィールド（family、give、prefix、suffix、および/またはtextを含む）のいずれかに一致するPatientリソースを検索する

    GET [base]/Patient?birthdate=eq{date}&name={string}&gender={token}

    例：

    GET [base]/Patient?birthdate=eq2000-10-10&name=山田%20太郎&gender=male

  5. name, phone 検索パラメータを使用してPatientの検索をサポートすることが望ましい（SHOULD）、name検索パラメータはHumanNameの文字列フィールド（family、give、prefix、suffix、および/またはtextを含む）のいずれかに一致するPatientリソースを検索する

    GET [base]/Patient?name={string}&phone={token}

    例：

    GET [base]/Patient?name=山田%20太郎&phone=0123456789

  6. name, address-postalcode 検索パラメータを使用してPatientの検索をサポートすることが望ましい（SHOULD）、name検索パラメータはHumanNameの文字列フィールド（family、give、prefix、suffix、および/またはtextを含む）のいずれかに一致するPatientリソースを検索する、address-postalcodeはPatient.address.postalCode要素に対する検索パラメータであり日本の住所表記における郵便番号をキーにして検索することを想定している

    GET [base]/Patient?name={string}&address-postalcode={string}

    例：

    GET [base]/Patient?name=山田%20太郎&address-postalcode=1234567
オプション検索パラメータ

オプションとして次の検索パラメータをサポートすることができる。

  1. 複合条件として、family,given,birthdate,gender,phone,address-postalcodename の各検索パラメータを複数指定したPatientの検索をサポートすることができる（MAY）

    GET [base]/Patient?family={string}&given={string}&birthdate=eq{date}&gender={token}&phone={token}&address-postalcode={string}

    例：

    GET [base]/Patient?family=山田&given=太郎&birthdate=eq2013-01-14&gender=male&phone=111-222-3333&address-postalcode=1234567

    family,given,birthdate,gender,phone,address-postalcodename の各検索パラメータに一致するPatientリソースを含むBundleを検索する。

追加検索パラメータ

カナ名称ソート用の検索パラメータ[jp-patient-kanasort-sp]を追加している。

Operation一覧

JP Patient リソースに対して使用される操作は次の通りである。

  • $everything：[base]/Patient/$everything , [base]/Patient/[id]/$everything

    • この操作が呼び出された場合、すべての患者の、あるいは指定された特定の[id]をもつPatientに関連した全てのリソースを返す
$everything 操作

この操作は、この操作が呼び出された特定のPatientリソースに関連する全ての情報を返す。応答は "searchset" タイプのBundleリソースである。サーバは、少なくとも、識別された医療従事者のPatientコンパートメントに含まれる全てのリソースと、それらから参照されるすべてのリソースを返すことが望ましい。

この操作の公式なURLは以下である。

http://hl7.jp/fhir/OperationDefinition/Patient-everything

URL: [base]/Patient/[id]/$everything

本操作は、べき等な操作である。

入力パラメータ
名前 多重度 型 説明
start 0..1 date 特定の日付範囲で提供されたケアに関連する全ての記録を意味する。開始日が指定されていない場合、終了日以前のすべてのレコードが対象に含まれる。
end 0..1 date 特定の日付範囲で提供されたケアに関連する全ての記録を意味する。終了日が指定されていない場合、開始日以降のすべてのレコードが対象に含まれる。
_since 0..1 instant 指定された日時以降に更新されたリソースのみが応答に含まれる。
_type 0..* code 応答に含むFHIRリソース型を、カンマ区切りで指定する。指定されない場合は、サーバは全てのリソース型を対象とする。
_count 0..1 integer Bundleの1ページに含まれるリソース件数を指定。
出力パラメータ
名前 多重度 型 説明
return 1..1 Bundle バンドルのタイプは"searchset"である。この操作の結果は、リソースとして直接返される。
例

リクエスト：単一のPatientに関連する全てのリソースを取得する。

GET [base]/Patient/p001/$everything
[some headers]

レスポンス：指定されたPatientに関連する全てのリソースを返す。

HTTP/1.1 200 OK [other headers]

    {
      "resourceType": "Bundle",
      "id": "example",
      "meta": {
        "lastUpdated": "2014-08-18T01:43:33Z"
      },
      "type": "searchset",
      "entry": [
        {
          "fullUrl": "http://example.org/fhir/Patient/p001",
          "resource": {
            "resourceType": "Patient",
            省略
          }
        }
      ]
    }

サンプル

その他、参考文献・リンク等

  1. 退院時サマリー規約 http://www.hl7.jp/library/item/HL7J-CDA-007.pdf
  2. 診療情報提供書規格 http://www.hl7.jp/intro/std/HL7J-CDA-005.pdf
  3. 特定健診情報ファイル仕様 https://www.mhlw.go.jp/stf/seisakunitsuite/bunya/0000165280.html
  4. SS-MIX2 標準化ストレージ 仕様書 Ver.1.2h https://www.jami.jp/jamistd/docs/SS-MIX2/h/SS-MIX2_StndrdStrgSpecVer.1.2h.pdf
  5. ICSR E2B(R3) https://www.pmda.go.jp/int-activities/int-harmony/ich/0093.html
本実装ガイドへのご質問・ご指摘については、GitHub IssueおよびGitHub PullRequestにて受け付けております。