台灣癌症登記長表實作指引 (Taiwan Cancer Registry Long Form Implementation Guide)
0.1.1 - ci-build
台灣癌症登記長表實作指引 (Taiwan Cancer Registry Long Form Implementation Guide) - Local Development build (v0.1.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-Patient-profile | Version: 0.1.1 | |||
Active as of 2024-08-01 | Computable Name: LFPatientProfile |
個案的病患基本資料
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | Patient | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
LastContactOrDeath | S | 0..1 | dateTime | Last Contact or Death(最後連絡或死亡日期) URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-LastContactOrDeath-extension |
Slices for identifier | S | 2..* | Identifier | 個案的身份識別碼(identifier) Slice: Unordered, Open by value:type.coding.code |
identifier:idCardNumber | S | 1..1 | Identifier | 適用身分證字號 |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official |
type | S | 1..1 | CodeableConcept | 身份識別碼(identifier)的型別說明 |
coding | S | 1..* | Coding | 由專門術語系統(terminology system)所定義之代碼的參照 |
system | S | 1..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
code | S | 1..1 | code | 系統定義的語法之符號 Required Pattern: NNxxx |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-suffix | S | 0..1 | (Complex) | Identifier Suffix URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-IdentifierSuffix-extension |
display | S | 0..1 | string | 代碼系統定義的表示法 Required Pattern: National Person Identifier where the xxx is the ISO table 3166 3-character (alphabetic) country code |
text | S | 0..1 | string | 概念的文字表示法 |
system | S | 1..1 | uri | 身份識別碼(identifier)的命名空間(namespace) 例如:身分證字號='http://www.moi.gov.tw/' Required Pattern: http://www.moi.gov.tw |
value | S | 1..1 | string | 唯一值。 例如:身分證字號為A123456789 |
identifier:medicalRecord | S | 1..1 | Identifier | 適用病歷號 |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official |
type | S | 1..1 | CodeableConcept | 身份識別碼(identifier)的型別說明 |
coding | S | 1..* | Coding | 由專門術語系統(terminology system)所定義之代碼的參照 |
system | S | 1..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
code | S | 1..1 | code | 系統定義的語法之符號 Required Pattern: MR |
display | S | 0..1 | string | 代碼系統定義的表示法 Required Pattern: Medical record number |
text | S | 0..1 | string | 概念的文字表示法 |
system | S | 1..1 | uri | 身份識別碼(identifier)的命名空間(namespace) |
value | S | 1..1 | string | 唯一值。 例如:病歷號為8862168 |
name | S | 1..* | HumanName | 個案的姓名 |
use | S | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
text | S | 1..1 | string | 完整的中文姓名 |
family | S | 0..1 | string | Family name (often called 'Surname') |
given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
gender | S | 1..1 | code | 個案的性別 |
birthDate | S | 0..1 | date | 個案的出生日期 |
Slices for deceased[x] | 1..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |
deceased[x]:deceasedBoolean | S | 1..1 | boolean | 記錄個案「最後聯絡或死亡日期」的存活狀態 |
address | S | 1..* | Address | 個案在診斷為癌症時之戶籍地 |
postalCode | S | 1..1 | string | 個案在診斷為癌症時之戶籍地代碼 |
managingOrganization | S | 1..1 | Reference(Organization Profile) | 此個案之申報醫院 |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
LastContactOrDeath | S | 0..1 | dateTime | Last Contact or Death(最後連絡或死亡日期) URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-LastContactOrDeath-extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 2..* | Identifier | 個案的身份識別碼(identifier) Slice: Unordered, Open by value:type.coding.code |
identifier:idCardNumber | SΣ | 1..1 | Identifier | 適用身分證字號 |
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
type | SΣ | 1..1 | CodeableConcept | 身份識別碼(identifier)的型別說明 Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
coding | SΣ | 1..* | Coding | 由專門術語系統(terminology system)所定義之代碼的參照 |
system | SΣ | 1..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
code | SΣ | 1..1 | code | 系統定義的語法之符號 Required Pattern: NNxxx |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-suffix | S | 0..1 | (Complex) | Identifier Suffix URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-IdentifierSuffix-extension |
display | SΣ | 0..1 | string | 代碼系統定義的表示法 Required Pattern: National Person Identifier where the xxx is the ISO table 3166 3-character (alphabetic) country code |
text | SΣ | 0..1 | string | 概念的文字表示法 |
system | SΣ | 1..1 | uri | 身份識別碼(identifier)的命名空間(namespace) 例如:身分證字號='http://www.moi.gov.tw/' Required Pattern: http://www.moi.gov.tw |
value | SΣ | 1..1 | string | 唯一值。 例如:身分證字號為A123456789 Example General: 123456 |
identifier:medicalRecord | SΣ | 1..1 | Identifier | 適用病歷號 |
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
type | SΣ | 1..1 | CodeableConcept | 身份識別碼(identifier)的型別說明 Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
coding | SΣ | 1..* | Coding | 由專門術語系統(terminology system)所定義之代碼的參照 |
system | SΣ | 1..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
code | SΣ | 1..1 | code | 系統定義的語法之符號 Required Pattern: MR |
display | SΣ | 0..1 | string | 代碼系統定義的表示法 Required Pattern: Medical record number |
text | SΣ | 0..1 | string | 概念的文字表示法 |
system | SΣ | 1..1 | uri | 身份識別碼(identifier)的命名空間(namespace) Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | 唯一值。 例如:病歷號為8862168 Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
name | SΣ | 1..* | HumanName | 個案的姓名 |
use | ?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
text | SΣ | 1..1 | string | 完整的中文姓名 |
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
gender | SΣ | 1..1 | code | 個案的性別 Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
birthDate | SΣ | 0..1 | date | 個案的出生日期 |
Slices for deceased[x] | ?!Σ | 1..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this |
deceased[x]:deceasedBoolean | ?!SΣ | 1..1 | boolean | 記錄個案「最後聯絡或死亡日期」的存活狀態 |
address | SΣ | 1..* | Address | 個案在診斷為癌症時之戶籍地 |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
postalCode | SΣ | 1..1 | string | 個案在診斷為癌症時之戶籍地代碼 Example General: 9132 |
managingOrganization | SΣ | 1..1 | Reference(Organization Profile) | 此個案之申報醫院 |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(Patient | 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. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Patient.identifier:idCardNumber.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:idCardNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Patient.identifier:medicalRecord.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:medicalRecord.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | |
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
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): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
LastContactOrDeath | S | 0..1 | dateTime | Last Contact or Death(最後連絡或死亡日期) URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-LastContactOrDeath-extension | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 2..* | Identifier | 個案的身份識別碼(identifier) Slice: Unordered, Open by value:type.coding.code | ||||
identifier:idCardNumber | SΣ | 1..1 | Identifier | 適用身分證字號 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
type | SΣ | 1..1 | CodeableConcept | 身份識別碼(identifier)的型別說明 Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..* | Coding | 由專門術語系統(terminology system)所定義之代碼的參照 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | 系統定義的語法之符號 Required Pattern: NNxxx | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
identifier-suffix | S | 0..1 | (Complex) | Identifier Suffix URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-IdentifierSuffix-extension | ||||
value | 0..1 | string | Primitive value for code | |||||
display | SΣ | 0..1 | string | 代碼系統定義的表示法 Required Pattern: National Person Identifier where the xxx is the ISO table 3166 3-character (alphabetic) country code | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | SΣ | 0..1 | string | 概念的文字表示法 | ||||
system | SΣ | 1..1 | uri | 身份識別碼(identifier)的命名空間(namespace) 例如:身分證字號='http://www.moi.gov.tw/' Required Pattern: http://www.moi.gov.tw | ||||
value | SΣ | 1..1 | string | 唯一值。 例如:身分證字號為A123456789 Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:medicalRecord | SΣ | 1..1 | Identifier | 適用病歷號 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
type | SΣ | 1..1 | CodeableConcept | 身份識別碼(identifier)的型別說明 Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..* | Coding | 由專門術語系統(terminology system)所定義之代碼的參照 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | 系統定義的語法之符號 Required Pattern: MR | ||||
display | SΣ | 0..1 | string | 代碼系統定義的表示法 Required Pattern: Medical record number | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | SΣ | 0..1 | string | 概念的文字表示法 | ||||
system | SΣ | 1..1 | uri | 身份識別碼(identifier)的命名空間(namespace) Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | 唯一值。 例如:病歷號為8862168 Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
name | SΣ | 1..* | HumanName | 個案的姓名 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | SΣ | 1..1 | string | 完整的中文姓名 | ||||
family | SΣ | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
gender | SΣ | 1..1 | code | 個案的性別 Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | SΣ | 0..1 | date | 個案的出生日期 | ||||
Slices for deceased[x] | ?!Σ | 1..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | ||||
deceased[x]:deceasedBoolean | ?!SΣ | 1..1 | boolean | 記錄個案「最後聯絡或死亡日期」的存活狀態 | ||||
address | SΣ | 1..* | Address | 個案在診斷為癌症時之戶籍地 | ||||
id | 0..1 | string | 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. 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 | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | SΣ | 1..1 | string | 個案在診斷為癌症時之戶籍地代碼 Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient 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 | The kind of relationship 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(Organization) | 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 | A language which may be used to communicate with the patient about his or her health | |||||
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 | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
managingOrganization | SΣ | 1..1 | Reference(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(Patient | 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. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier:idCardNumber.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:idCardNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:medicalRecord.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:medicalRecord.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.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() |
This structure is derived from Patient
Summary
Mandatory: 22 elements
Must-Support: 34 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | Patient | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
LastContactOrDeath | S | 0..1 | dateTime | Last Contact or Death(最後連絡或死亡日期) URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-LastContactOrDeath-extension |
Slices for identifier | S | 2..* | Identifier | 個案的身份識別碼(identifier) Slice: Unordered, Open by value:type.coding.code |
identifier:idCardNumber | S | 1..1 | Identifier | 適用身分證字號 |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official |
type | S | 1..1 | CodeableConcept | 身份識別碼(identifier)的型別說明 |
coding | S | 1..* | Coding | 由專門術語系統(terminology system)所定義之代碼的參照 |
system | S | 1..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
code | S | 1..1 | code | 系統定義的語法之符號 Required Pattern: NNxxx |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-suffix | S | 0..1 | (Complex) | Identifier Suffix URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-IdentifierSuffix-extension |
display | S | 0..1 | string | 代碼系統定義的表示法 Required Pattern: National Person Identifier where the xxx is the ISO table 3166 3-character (alphabetic) country code |
text | S | 0..1 | string | 概念的文字表示法 |
system | S | 1..1 | uri | 身份識別碼(identifier)的命名空間(namespace) 例如:身分證字號='http://www.moi.gov.tw/' Required Pattern: http://www.moi.gov.tw |
value | S | 1..1 | string | 唯一值。 例如:身分證字號為A123456789 |
identifier:medicalRecord | S | 1..1 | Identifier | 適用病歷號 |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official |
type | S | 1..1 | CodeableConcept | 身份識別碼(identifier)的型別說明 |
coding | S | 1..* | Coding | 由專門術語系統(terminology system)所定義之代碼的參照 |
system | S | 1..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
code | S | 1..1 | code | 系統定義的語法之符號 Required Pattern: MR |
display | S | 0..1 | string | 代碼系統定義的表示法 Required Pattern: Medical record number |
text | S | 0..1 | string | 概念的文字表示法 |
system | S | 1..1 | uri | 身份識別碼(identifier)的命名空間(namespace) |
value | S | 1..1 | string | 唯一值。 例如:病歷號為8862168 |
name | S | 1..* | HumanName | 個案的姓名 |
use | S | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
text | S | 1..1 | string | 完整的中文姓名 |
family | S | 0..1 | string | Family name (often called 'Surname') |
given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
gender | S | 1..1 | code | 個案的性別 |
birthDate | S | 0..1 | date | 個案的出生日期 |
Slices for deceased[x] | 1..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |
deceased[x]:deceasedBoolean | S | 1..1 | boolean | 記錄個案「最後聯絡或死亡日期」的存活狀態 |
address | S | 1..* | Address | 個案在診斷為癌症時之戶籍地 |
postalCode | S | 1..1 | string | 個案在診斷為癌症時之戶籍地代碼 |
managingOrganization | S | 1..1 | Reference(Organization Profile) | 此個案之申報醫院 |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
LastContactOrDeath | S | 0..1 | dateTime | Last Contact or Death(最後連絡或死亡日期) URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-LastContactOrDeath-extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 2..* | Identifier | 個案的身份識別碼(identifier) Slice: Unordered, Open by value:type.coding.code |
identifier:idCardNumber | SΣ | 1..1 | Identifier | 適用身分證字號 |
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
type | SΣ | 1..1 | CodeableConcept | 身份識別碼(identifier)的型別說明 Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
coding | SΣ | 1..* | Coding | 由專門術語系統(terminology system)所定義之代碼的參照 |
system | SΣ | 1..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
code | SΣ | 1..1 | code | 系統定義的語法之符號 Required Pattern: NNxxx |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-suffix | S | 0..1 | (Complex) | Identifier Suffix URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-IdentifierSuffix-extension |
display | SΣ | 0..1 | string | 代碼系統定義的表示法 Required Pattern: National Person Identifier where the xxx is the ISO table 3166 3-character (alphabetic) country code |
text | SΣ | 0..1 | string | 概念的文字表示法 |
system | SΣ | 1..1 | uri | 身份識別碼(identifier)的命名空間(namespace) 例如:身分證字號='http://www.moi.gov.tw/' Required Pattern: http://www.moi.gov.tw |
value | SΣ | 1..1 | string | 唯一值。 例如:身分證字號為A123456789 Example General: 123456 |
identifier:medicalRecord | SΣ | 1..1 | Identifier | 適用病歷號 |
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
type | SΣ | 1..1 | CodeableConcept | 身份識別碼(identifier)的型別說明 Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
coding | SΣ | 1..* | Coding | 由專門術語系統(terminology system)所定義之代碼的參照 |
system | SΣ | 1..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
code | SΣ | 1..1 | code | 系統定義的語法之符號 Required Pattern: MR |
display | SΣ | 0..1 | string | 代碼系統定義的表示法 Required Pattern: Medical record number |
text | SΣ | 0..1 | string | 概念的文字表示法 |
system | SΣ | 1..1 | uri | 身份識別碼(identifier)的命名空間(namespace) Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | 唯一值。 例如:病歷號為8862168 Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
name | SΣ | 1..* | HumanName | 個案的姓名 |
use | ?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
text | SΣ | 1..1 | string | 完整的中文姓名 |
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
gender | SΣ | 1..1 | code | 個案的性別 Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
birthDate | SΣ | 0..1 | date | 個案的出生日期 |
Slices for deceased[x] | ?!Σ | 1..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this |
deceased[x]:deceasedBoolean | ?!SΣ | 1..1 | boolean | 記錄個案「最後聯絡或死亡日期」的存活狀態 |
address | SΣ | 1..* | Address | 個案在診斷為癌症時之戶籍地 |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
postalCode | SΣ | 1..1 | string | 個案在診斷為癌症時之戶籍地代碼 Example General: 9132 |
managingOrganization | SΣ | 1..1 | Reference(Organization Profile) | 此個案之申報醫院 |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(Patient | 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. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Patient.identifier:idCardNumber.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:idCardNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Patient.identifier:medicalRecord.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:medicalRecord.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | |
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
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): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
LastContactOrDeath | S | 0..1 | dateTime | Last Contact or Death(最後連絡或死亡日期) URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-LastContactOrDeath-extension | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 2..* | Identifier | 個案的身份識別碼(identifier) Slice: Unordered, Open by value:type.coding.code | ||||
identifier:idCardNumber | SΣ | 1..1 | Identifier | 適用身分證字號 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
type | SΣ | 1..1 | CodeableConcept | 身份識別碼(identifier)的型別說明 Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..* | Coding | 由專門術語系統(terminology system)所定義之代碼的參照 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | 系統定義的語法之符號 Required Pattern: NNxxx | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
identifier-suffix | S | 0..1 | (Complex) | Identifier Suffix URL: https://hapi.fhir.tw/fhir/StructureDefinition/lf-IdentifierSuffix-extension | ||||
value | 0..1 | string | Primitive value for code | |||||
display | SΣ | 0..1 | string | 代碼系統定義的表示法 Required Pattern: National Person Identifier where the xxx is the ISO table 3166 3-character (alphabetic) country code | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | SΣ | 0..1 | string | 概念的文字表示法 | ||||
system | SΣ | 1..1 | uri | 身份識別碼(identifier)的命名空間(namespace) 例如:身分證字號='http://www.moi.gov.tw/' Required Pattern: http://www.moi.gov.tw | ||||
value | SΣ | 1..1 | string | 唯一值。 例如:身分證字號為A123456789 Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:medicalRecord | SΣ | 1..1 | Identifier | 適用病歷號 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
type | SΣ | 1..1 | CodeableConcept | 身份識別碼(identifier)的型別說明 Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..* | Coding | 由專門術語系統(terminology system)所定義之代碼的參照 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | 系統定義的語法之符號 Required Pattern: MR | ||||
display | SΣ | 0..1 | string | 代碼系統定義的表示法 Required Pattern: Medical record number | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | SΣ | 0..1 | string | 概念的文字表示法 | ||||
system | SΣ | 1..1 | uri | 身份識別碼(identifier)的命名空間(namespace) Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | 唯一值。 例如:病歷號為8862168 Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
name | SΣ | 1..* | HumanName | 個案的姓名 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | SΣ | 1..1 | string | 完整的中文姓名 | ||||
family | SΣ | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
gender | SΣ | 1..1 | code | 個案的性別 Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | SΣ | 0..1 | date | 個案的出生日期 | ||||
Slices for deceased[x] | ?!Σ | 1..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | ||||
deceased[x]:deceasedBoolean | ?!SΣ | 1..1 | boolean | 記錄個案「最後聯絡或死亡日期」的存活狀態 | ||||
address | SΣ | 1..* | Address | 個案在診斷為癌症時之戶籍地 | ||||
id | 0..1 | string | 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. 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 | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | SΣ | 1..1 | string | 個案在診斷為癌症時之戶籍地代碼 Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient 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 | The kind of relationship 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(Organization) | 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 | A language which may be used to communicate with the patient about his or her health | |||||
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 | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
managingOrganization | SΣ | 1..1 | Reference(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(Patient | 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. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier:idCardNumber.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:idCardNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:medicalRecord.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:medicalRecord.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.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() |
This structure is derived from Patient
Summary
Mandatory: 22 elements
Must-Support: 34 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron