基于FHIR标准的健康档案共享文档实施指南
0.8.0.2022705 - 持续集成版
基于FHIR的健康档案共享文档实施时必须严格遵循本实施指南的规定。
Defining URL: | http://hl7.org.cn/fhir/sd/ehr/StructureDefinition/profile-family-member-diseases |
Version: | 0.8.0.2022705 |
Name: | FamilyMemberDiseases |
Title: | 家族史疾病结构定义 |
Status: | Active as of 2022-07-05T13:46:42+08:00 |
Definition: | 家族史疾病结构定义。 |
Publisher: | CHIMA&HL7中国委员会 |
Source Resource: | XML / JSON / Turtle |
家族史疾病结构定义的正式唯一标识为:
http://hl7.org.cn/fhir/sd/ehr/StructureDefinition/profile-family-member-diseases
家族史疾病结构定义是在FHIR标准的FamilyMemberHistory基础上进行更加详细的规则约束,下表展示了家族史疾病结构定义的结构表示。
这种结构源自 FamilyMemberHistory
Summary
Mandatory: 1 element (4 nested mandatory elements)
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
这种结构源自 FamilyMemberHistory
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient | |
status | 1..1 | code | partial | completed | entered-in-error | health-unknown Required Pattern: completed | |
patient | 1..1 | Reference(患者信息结构定义) | 指向居民本身。不是其他家族成员。 | |
relationship | 1..1 | CodeableConcept | 家族成员与居民本人的关系。 Binding: 家庭关系代码表 (required) | |
sex | S | 0..1 | CodeableConcept | 家族成员的性别 Binding: 生理性别代码表 (required) |
age[x] | S | 0..1 | (Slice Definition) | 记录家族成员的年龄 Slice: Unordered, Open by type:$this |
ageAge | 0..1 | Age | 年龄类型 | |
value | 1..1 | decimal | Numerical value (with implicit precision) | |
unit | 1..1 | string | Unit representation Required Pattern: 年 | |
system | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | |
code | 1..1 | code | Coded form of the unit Required Pattern: a | |
condition | 1..* | BackboneElement | 记录家族成员的疾病 | |
code | 1..1 | CodeableConcept | Condition suffered by relation Binding: 既往常见疾病种类代码表 (required) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | I | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Id(s) for this record |
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
status | ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. Required Pattern: completed |
dataAbsentReason | Σ | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available. |
patient | Σ | 1..1 | Reference(患者信息结构定义) | 指向居民本身。不是其他家族成员。 |
date | Σ | 0..1 | dateTime | When history was recorded or last updated |
name | Σ | 0..1 | string | The family member described |
relationship | Σ | 1..1 | CodeableConcept | 家族成员与居民本人的关系。 Binding: 家庭关系代码表 (required) |
sex | SΣ | 0..1 | CodeableConcept | 家族成员的性别 Binding: 生理性别代码表 (required) |
born[x] | I | 0..1 | (approximate) date of birth | |
bornPeriod | Period | |||
bornDate | date | |||
bornString | string | |||
age[x] | SΣI | 0..1 | (Slice Definition) | 记录家族成员的年龄 Slice: Unordered, Closed by type:$this |
age[x]:ageAge | ΣI | 0..1 | Age | 年龄类型 |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | Σ | 1..1 | string | Unit representation Required Pattern: 年 |
system | ΣI | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org |
code | Σ | 1..1 | code | Coded form of the unit Required Pattern: a |
estimatedAge | ΣI | 0..1 | boolean | Age is estimated? |
deceased[x] | Σ | 0..1 | Dead? How old/when? | |
deceasedBoolean | boolean | |||
deceasedAge | Age | |||
deceasedRange | Range | |||
deceasedDate | date | |||
deceasedString | string | |||
reasonCode | Σ | 0..* | CodeableConcept | Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done. |
reasonReference | Σ | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | Why was family member history performed? |
note | 0..* | Annotation | General note about related person | |
condition | 1..* | 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 |
code | 1..1 | CodeableConcept | Condition suffered by relation Binding: 既往常见疾病种类代码表 (required) | |
outcome | 0..1 | CodeableConcept | deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. | |
contributedToDeath | 0..1 | boolean | Whether the condition contributed to the cause of death | |
onset[x] | 0..1 | When condition first manifested | ||
onsetAge | Age | |||
onsetRange | Range | |||
onsetPeriod | Period | |||
onsetString | string | |||
note | 0..* | Annotation | Extra information about condition | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | I | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient |
sex | Σ | 0..1 | CodeableConcept | 家族成员的性别 Binding: 生理性别代码表 (required) |
age[x] | ΣI | 0..1 | (Slice Definition) | 记录家族成员的年龄 Slice: Unordered, Closed by type:$this |
Documentation for this format |
这种结构源自 FamilyMemberHistory
Summary
Mandatory: 1 element (4 nested mandatory elements)
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
差异视图
这种结构源自 FamilyMemberHistory
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient | |
status | 1..1 | code | partial | completed | entered-in-error | health-unknown Required Pattern: completed | |
patient | 1..1 | Reference(患者信息结构定义) | 指向居民本身。不是其他家族成员。 | |
relationship | 1..1 | CodeableConcept | 家族成员与居民本人的关系。 Binding: 家庭关系代码表 (required) | |
sex | S | 0..1 | CodeableConcept | 家族成员的性别 Binding: 生理性别代码表 (required) |
age[x] | S | 0..1 | (Slice Definition) | 记录家族成员的年龄 Slice: Unordered, Open by type:$this |
ageAge | 0..1 | Age | 年龄类型 | |
value | 1..1 | decimal | Numerical value (with implicit precision) | |
unit | 1..1 | string | Unit representation Required Pattern: 年 | |
system | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | |
code | 1..1 | code | Coded form of the unit Required Pattern: a | |
condition | 1..* | BackboneElement | 记录家族成员的疾病 | |
code | 1..1 | CodeableConcept | Condition suffered by relation Binding: 既往常见疾病种类代码表 (required) | |
Documentation for this format |
快照视图
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | I | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Id(s) for this record |
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
status | ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. Required Pattern: completed |
dataAbsentReason | Σ | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available. |
patient | Σ | 1..1 | Reference(患者信息结构定义) | 指向居民本身。不是其他家族成员。 |
date | Σ | 0..1 | dateTime | When history was recorded or last updated |
name | Σ | 0..1 | string | The family member described |
relationship | Σ | 1..1 | CodeableConcept | 家族成员与居民本人的关系。 Binding: 家庭关系代码表 (required) |
sex | SΣ | 0..1 | CodeableConcept | 家族成员的性别 Binding: 生理性别代码表 (required) |
born[x] | I | 0..1 | (approximate) date of birth | |
bornPeriod | Period | |||
bornDate | date | |||
bornString | string | |||
age[x] | SΣI | 0..1 | (Slice Definition) | 记录家族成员的年龄 Slice: Unordered, Closed by type:$this |
age[x]:ageAge | ΣI | 0..1 | Age | 年龄类型 |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | Σ | 1..1 | string | Unit representation Required Pattern: 年 |
system | ΣI | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org |
code | Σ | 1..1 | code | Coded form of the unit Required Pattern: a |
estimatedAge | ΣI | 0..1 | boolean | Age is estimated? |
deceased[x] | Σ | 0..1 | Dead? How old/when? | |
deceasedBoolean | boolean | |||
deceasedAge | Age | |||
deceasedRange | Range | |||
deceasedDate | date | |||
deceasedString | string | |||
reasonCode | Σ | 0..* | CodeableConcept | Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done. |
reasonReference | Σ | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | Why was family member history performed? |
note | 0..* | Annotation | General note about related person | |
condition | 1..* | 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 |
code | 1..1 | CodeableConcept | Condition suffered by relation Binding: 既往常见疾病种类代码表 (required) | |
outcome | 0..1 | CodeableConcept | deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. | |
contributedToDeath | 0..1 | boolean | Whether the condition contributed to the cause of death | |
onset[x] | 0..1 | When condition first manifested | ||
onsetAge | Age | |||
onsetRange | Range | |||
onsetPeriod | Period | |||
onsetString | string | |||
note | 0..* | Annotation | Extra information about condition | |
Documentation for this format |
本定义的其它表示法: Schematron
Path | Conformance | ValueSet / Code |
FamilyMemberHistory.language | preferred | CommonLanguages Max Binding: AllLanguages |
FamilyMemberHistory.status | required | Pattern: completed |
FamilyMemberHistory.dataAbsentReason | example | FamilyHistoryAbsentReason |
FamilyMemberHistory.relationship | required | GB4761_2008 |
FamilyMemberHistory.sex | required | GB2261_1_2003 |
FamilyMemberHistory.age[x]:ageAge.comparator | required | QuantityComparator |
FamilyMemberHistory.reasonCode | example | SNOMEDCTClinicalFindings |
FamilyMemberHistory.condition.code | required | CV02_10_005 |
FamilyMemberHistory.condition.outcome | example | ConditionOutcomeCodes |
Id | Path | Details | Requirements |
dom-2 | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | FamilyMemberHistory | 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 | FamilyMemberHistory | 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 | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | FamilyMemberHistory | A resource should have narrative for robust management : text.`div`.exists() | |
fhs-1 | FamilyMemberHistory | Can have age[x] or born[x], but not both : age.empty() or born.empty() | |
fhs-2 | FamilyMemberHistory | Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty() | |
ele-1 | FamilyMemberHistory.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | FamilyMemberHistory.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | FamilyMemberHistory.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | FamilyMemberHistory.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | FamilyMemberHistory.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.sex | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.born[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.age[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.age[x]:ageAge | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.age[x]:ageAge.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | FamilyMemberHistory.age[x]:ageAge.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | FamilyMemberHistory.age[x]:ageAge.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.age[x]:ageAge.comparator | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.age[x]:ageAge.unit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.age[x]:ageAge.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.age[x]:ageAge.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.estimatedAge | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.deceased[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.condition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.condition.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | FamilyMemberHistory.condition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | FamilyMemberHistory.condition.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | FamilyMemberHistory.condition.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | FamilyMemberHistory.condition.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.condition.outcome | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.condition.contributedToDeath | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.condition.onset[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | FamilyMemberHistory.condition.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |