HL7 Europe Hospital Discharge Report
0.1.0-ci-build - ci-build
150
HL7 Europe Hospital Discharge Report
0.1.0-ci-build - ci-build
150
HL7 Europe Hospital Discharge Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/hdr/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/hdr/StructureDefinition/familyMemberHistory-obl-eu-hdr | Version: 0.1.0-ci-build | |||
| Standards status: Informative | Maturity Level: 0 | Computable Name: FamilyMemberHistoryEuHdrObligation | ||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
||||
This profile represents the constraints applied to the FamilyMemberHistory resource by this guide.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  FamilyMemberHistory |
C | 0..* | FamilyMemberHistoryEuHdr | Information about patient's relatives, relevant for patient Constraints: fhs-1, fhs-2 | ||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| 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. | ||||||
 dataAbsentReason |
OΣ | 0..1 | CodeableConcept | Reason for missing data Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.
| ||||||
 patient |
OΣ | 1..1 | Reference(Patient (EU core)) | Patient history is about
| ||||||
| relationship |
OΣ | 1..1 | CodeableConcept | Relationship to the subject. Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.
| ||||||
  Slices for born[x] |
C | 0..1 | (approximate) date of birth Slice: Unordered, Open by type:$this | |||||||
  bornPeriod |
Period | |||||||||
| bornDate |
date | |||||||||
| bornString |
string | |||||||||
  born[x]:bornDate |
C | 0..1 | date | Date of birth of the relative | ||||||
| Slices for deceased[x] |
Σ | 0..1 | Dead? How old/when? Slice: Unordered, Closed by type:$this | |||||||
| deceasedBoolean |
boolean | |||||||||
| deceasedAge |
Age | |||||||||
| deceasedRange |
Range | |||||||||
| deceasedDate |
date | |||||||||
| deceasedString |
string | |||||||||
| deceased[x]:deceasedAge |
OΣ | 0..1 | Age | (Approximate) age at death of the relative
| ||||||
| deceased[x]:deceasedDate |
OΣ | 0..1 | date | Date of death of the relative
| ||||||
 condition |
O | 0..* | BackboneElement | Condition that the related person had
| ||||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| code |
O | 1..1 | CodeableConceptIPS(2.0.0) | Condition suffered by relation Binding: Condition Value Set (preferred)
| ||||||
 note |
O | 0..* | Annotation | Extra information about this condition
| ||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| FamilyMemberHistory.status | Base | required | FamilyHistoryStatus | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.dataAbsentReason | Base | example | FamilyHistoryAbsentReason | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.relationship | Base | example | FamilyMember | 📦3.0.0 | THO v7.0 |
| FamilyMemberHistory.condition.code | Base | preferred | Condition Value Set | 📦0.1.0-ci-build | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | 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 | error | 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 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | FamilyMemberHistory | 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()
|
| fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both |
age.empty() or born.empty()
|
| fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present |
age.exists() or estimatedAge.empty()
|
This structure is derived from FamilyMemberHistoryEuHdr
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| FamilyMemberHistory |
0..* | FamilyMemberHistoryEuHdr | Information about patient's relatives, relevant for patient | |||||||
 dataAbsentReason |
O | 0..1 | CodeableConcept | Reason for missing data
| ||||||
| patient |
O | 1..1 | Reference(Patient (EU core)) | Patient history is about
| ||||||
| relationship |
O | 1..1 | CodeableConcept | Relationship to the subject.
| ||||||
| Slices for deceased[x] |
Content/Rules for all slices | |||||||||
| deceased[x]:deceasedAge |
O | 0..1 | Age | (Approximate) age at death of the relative
| ||||||
| deceased[x]:deceasedDate |
O | 0..1 | date | Date of death of the relative
| ||||||
| condition |
O | 0..* | BackboneElement | Condition that the related person had
| ||||||
| code |
O | 1..1 | CodeableConceptIPS(2.0.0) | Condition suffered by relation
| ||||||
| note |
O | 0..* | Annotation | Extra information about this condition
| ||||||
| Documentation for this format | ||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| FamilyMemberHistory |
C | 0..* | FamilyMemberHistoryEuHdr | Information about patient's relatives, relevant for patient Constraints: fhs-1, fhs-2 | ||||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||
| 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. | ||||||
| dataAbsentReason |
OΣ | 0..1 | CodeableConcept | Reason for missing data Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.
| ||||||
| patient |
OΣ | 1..1 | Reference(Patient (EU core)) | Patient history is about
| ||||||
| date |
Σ | 0..1 | dateTime | When history was recorded or last updated | ||||||
| name |
Σ | 0..1 | string | The family member described | ||||||
| relationship |
OΣ | 1..1 | CodeableConcept | Relationship to the subject. Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.
| ||||||
| sex |
Σ | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration. | ||||||
| Slices for born[x] |
C | 0..1 | (approximate) date of birth Slice: Unordered, Open by type:$this | |||||||
| bornPeriod |
Period | |||||||||
| bornDate |
date | |||||||||
| bornString |
string | |||||||||
| born[x]:bornDate |
C | 0..1 | date | Date of birth of the relative | ||||||
 age[x] |
ΣC | 0..1 | (approximate) age | |||||||
| ageAge |
Age | |||||||||
| ageRange |
Range | |||||||||
| ageString |
string | |||||||||
| estimatedAge |
ΣC | 0..1 | boolean | Age is estimated? | ||||||
| Slices for deceased[x] |
Σ | 0..1 | Dead? How old/when? Slice: Unordered, Closed by type:$this | |||||||
| deceasedBoolean |
boolean | |||||||||
| deceasedAge |
Age | |||||||||
| deceasedRange |
Range | |||||||||
| deceasedDate |
date | |||||||||
| deceasedString |
string | |||||||||
| deceased[x]:deceasedAge |
OΣ | 0..1 | Age | (Approximate) age at death of the relative
| ||||||
| deceased[x]:deceasedDate |
OΣ | 0..1 | date | Date of death of the relative
| ||||||
| 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 |
O | 0..* | BackboneElement | Condition that the related person had
| ||||||
| 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 |
O | 1..1 | CodeableConceptIPS(2.0.0) | Condition suffered by relation Binding: Condition Value Set (preferred)
| ||||||
| 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 |
O | 0..* | Annotation | Extra information about this condition
| ||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| FamilyMemberHistory.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.status | Base | required | FamilyHistoryStatus | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.dataAbsentReason | Base | example | FamilyHistoryAbsentReason | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.relationship | Base | example | FamilyMember | 📦3.0.0 | THO v7.0 |
| FamilyMemberHistory.sex | Base | extensible | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.condition.code | Base | preferred | Condition Value Set | 📦0.1.0-ci-build | This IG |
| FamilyMemberHistory.condition.outcome | Base | example | Condition Outcome Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | 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 | error | 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 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | FamilyMemberHistory | 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()
|
| fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both |
age.empty() or born.empty()
|
| fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present |
age.exists() or estimatedAge.empty()
|
This structure is derived from FamilyMemberHistoryEuHdr
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| FamilyMemberHistory |
C | 0..* | FamilyMemberHistoryEuHdr | Information about patient's relatives, relevant for patient Constraints: fhs-1, fhs-2 | ||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| 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. | ||||||
| dataAbsentReason |
OΣ | 0..1 | CodeableConcept | Reason for missing data Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.
| ||||||
| patient |
OΣ | 1..1 | Reference(Patient (EU core)) | Patient history is about
| ||||||
| relationship |
OΣ | 1..1 | CodeableConcept | Relationship to the subject. Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.
| ||||||
| Slices for born[x] |
C | 0..1 | (approximate) date of birth Slice: Unordered, Open by type:$this | |||||||
| bornPeriod |
Period | |||||||||
| bornDate |
date | |||||||||
| bornString |
string | |||||||||
| born[x]:bornDate |
C | 0..1 | date | Date of birth of the relative | ||||||
| Slices for deceased[x] |
Σ | 0..1 | Dead? How old/when? Slice: Unordered, Closed by type:$this | |||||||
| deceasedBoolean |
boolean | |||||||||
| deceasedAge |
Age | |||||||||
| deceasedRange |
Range | |||||||||
| deceasedDate |
date | |||||||||
| deceasedString |
string | |||||||||
| deceased[x]:deceasedAge |
OΣ | 0..1 | Age | (Approximate) age at death of the relative
| ||||||
| deceased[x]:deceasedDate |
OΣ | 0..1 | date | Date of death of the relative
| ||||||
| condition |
O | 0..* | BackboneElement | Condition that the related person had
| ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| code |
O | 1..1 | CodeableConceptIPS(2.0.0) | Condition suffered by relation Binding: Condition Value Set (preferred)
| ||||||
| note |
O | 0..* | Annotation | Extra information about this condition
| ||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| FamilyMemberHistory.status | Base | required | FamilyHistoryStatus | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.dataAbsentReason | Base | example | FamilyHistoryAbsentReason | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.relationship | Base | example | FamilyMember | 📦3.0.0 | THO v7.0 |
| FamilyMemberHistory.condition.code | Base | preferred | Condition Value Set | 📦0.1.0-ci-build | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | 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 | error | 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 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | FamilyMemberHistory | 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()
|
| fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both |
age.empty() or born.empty()
|
| fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present |
age.exists() or estimatedAge.empty()
|
Differential View
This structure is derived from FamilyMemberHistoryEuHdr
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| FamilyMemberHistory |
0..* | FamilyMemberHistoryEuHdr | Information about patient's relatives, relevant for patient | |||||||
| dataAbsentReason |
O | 0..1 | CodeableConcept | Reason for missing data
| ||||||
| patient |
O | 1..1 | Reference(Patient (EU core)) | Patient history is about
| ||||||
| relationship |
O | 1..1 | CodeableConcept | Relationship to the subject.
| ||||||
| Slices for deceased[x] |
Content/Rules for all slices | |||||||||
| deceased[x]:deceasedAge |
O | 0..1 | Age | (Approximate) age at death of the relative
| ||||||
| deceased[x]:deceasedDate |
O | 0..1 | date | Date of death of the relative
| ||||||
| condition |
O | 0..* | BackboneElement | Condition that the related person had
| ||||||
| code |
O | 1..1 | CodeableConceptIPS(2.0.0) | Condition suffered by relation
| ||||||
| note |
O | 0..* | Annotation | Extra information about this condition
| ||||||
| Documentation for this format | ||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| FamilyMemberHistory |
C | 0..* | FamilyMemberHistoryEuHdr | Information about patient's relatives, relevant for patient Constraints: fhs-1, fhs-2 | ||||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||
| 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. | ||||||
| dataAbsentReason |
OΣ | 0..1 | CodeableConcept | Reason for missing data Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.
| ||||||
| patient |
OΣ | 1..1 | Reference(Patient (EU core)) | Patient history is about
| ||||||
| date |
Σ | 0..1 | dateTime | When history was recorded or last updated | ||||||
| name |
Σ | 0..1 | string | The family member described | ||||||
| relationship |
OΣ | 1..1 | CodeableConcept | Relationship to the subject. Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.
| ||||||
| sex |
Σ | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration. | ||||||
| Slices for born[x] |
C | 0..1 | (approximate) date of birth Slice: Unordered, Open by type:$this | |||||||
| bornPeriod |
Period | |||||||||
| bornDate |
date | |||||||||
| bornString |
string | |||||||||
| born[x]:bornDate |
C | 0..1 | date | Date of birth of the relative | ||||||
| age[x] |
ΣC | 0..1 | (approximate) age | |||||||
| ageAge |
Age | |||||||||
| ageRange |
Range | |||||||||
| ageString |
string | |||||||||
| estimatedAge |
ΣC | 0..1 | boolean | Age is estimated? | ||||||
| Slices for deceased[x] |
Σ | 0..1 | Dead? How old/when? Slice: Unordered, Closed by type:$this | |||||||
| deceasedBoolean |
boolean | |||||||||
| deceasedAge |
Age | |||||||||
| deceasedRange |
Range | |||||||||
| deceasedDate |
date | |||||||||
| deceasedString |
string | |||||||||
| deceased[x]:deceasedAge |
OΣ | 0..1 | Age | (Approximate) age at death of the relative
| ||||||
| deceased[x]:deceasedDate |
OΣ | 0..1 | date | Date of death of the relative
| ||||||
| 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 |
O | 0..* | BackboneElement | Condition that the related person had
| ||||||
| 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 |
O | 1..1 | CodeableConceptIPS(2.0.0) | Condition suffered by relation Binding: Condition Value Set (preferred)
| ||||||
| 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 |
O | 0..* | Annotation | Extra information about this condition
| ||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| FamilyMemberHistory.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.status | Base | required | FamilyHistoryStatus | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.dataAbsentReason | Base | example | FamilyHistoryAbsentReason | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.relationship | Base | example | FamilyMember | 📦3.0.0 | THO v7.0 |
| FamilyMemberHistory.sex | Base | extensible | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.condition.code | Base | preferred | Condition Value Set | 📦0.1.0-ci-build | This IG |
| FamilyMemberHistory.condition.outcome | Base | example | Condition Outcome Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | 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 | error | 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 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | FamilyMemberHistory | 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()
|
| fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both |
age.empty() or born.empty()
|
| fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present |
age.exists() or estimatedAge.empty()
|
This structure is derived from FamilyMemberHistoryEuHdr
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 Europe. Package hl7.fhir.eu.hdr#0.1.0-ci-build based on FHIR 4.0.1. Generated 2026-01-13
