Important: This is a draft IG for trial use. Click here to give feedback.

HdBe-FamilySituation

WARNING This page contains a draft CBB, as raw output from the zib export and automatic conversion to CBB. It requires thorough review and adaption to the Belgian realm. This CBB is merely added for informative use.

CBB	Description	Status
HdBe-FamilySituation	Traditionally, a family is defined as a group of people of one or more adults who carry responsibility for caring for and raising one or more children. Currently, the term is used more broadly for all forms of cohabitation which form a recognizable social unit, of people who are or who are not related and who have long-lasting, affective bonds and provide each other with support and care. Purpose Information on the patient’s family situation is important in determining the extent to which the patient receives and can receive care and support. For example, the age of the patient’s children partially determines whether they can play a role in caregiving. It is also important to know whether the patient needs support for daycare and/or care for dependent family members. Situations in which this information is important include for example being discharged from the hospital or nursing home. Instructions Care for family members who depend on the patient is described in the Care Responsibility concept. Family members who can provide the patient with care as a caregiver are entered as a caregiver in the HelpFromOthers information model. Because of KOPP policy (Kinderen van Ouders met Psychiatrische Problemen, or Children of Parents with Psychiatric Problems) mental healthcare facilities require a record stating whether there are children in the family. This means that in a mental healthcare situation, the number of children (living at home) must be recorded, with information per individual child or as a total number.	draft

CBB

Description

Status

HdBe-FamilySituation

Traditionally, a family is defined as a group of people of one or more adults who carry responsibility for caring for and raising one or more children. Currently, the term is used more broadly for all forms of cohabitation which form a recognizable social unit, of people who are or who are not related and who have long-lasting, affective bonds and provide each other with support and care.

Purpose

Information on the patient’s family situation is important in determining the extent to which the patient receives and can receive care and support. For example, the age of the patient’s children partially determines whether they can play a role in caregiving. It is also important to know whether the patient needs support for daycare and/or care for dependent family members. Situations in which this information is important include for example being discharged from the hospital or nursing home.

Instructions

Care for family members who depend on the patient is described in the Care Responsibility concept. Family members who can provide the patient with care as a caregiver are entered as a caregiver in the HelpFromOthers information model.

Because of KOPP policy (Kinderen van Ouders met Psychiatrische Problemen, or Children of Parents with Psychiatric Problems) mental healthcare facilities require a record stating whether there are children in the family. This means that in a mental healthcare situation, the number of children (living at home) must be recorded, with information per individual child or as a total number.

draft

FamilySituation			FamilySituation	Element id FamilySituation Short description FamilySituation Definition Root concept of the FamilySituation information model. This concept contains all data elements of the FamilySituation information model. Data type FamilySituation Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	There are no (further) constraints on this element Element id FamilySituation.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id FamilySituation.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
MaritalStatus	I	0..1	Reference(HdBe-MaritalStatus)	Element id FamilySituation.MaritalStatus Short description MaritalStatus Definition Patient’s marital status. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(HdBe-MaritalStatus) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
FamilyComposition		0..1	CodeableConceptBinding	Element id FamilySituation.FamilyComposition Short description FamilyComposition Definition The family composition describes the patient’s home situation and the form of cohabitation. A family can consist of one or more people. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding FamilyComposition codes FamilyComposition (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
NumberOfChildren		0..1	positiveInt	Element id FamilySituation.NumberOfChildren Short description NumberOfChildren Definition The number of children the patient has. Children in the context of this information model include step children, foster children, biological and adopted children. Comments 32 bit number; for values larger than this, use decimal Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
NumberOfChildrenLivingAtHome		0..1	positiveInt	Element id FamilySituation.NumberOfChildrenLivingAtHome Short description NumberOfChildrenLivingAtHome Definition The number of children living at home with the patient. Comments 32 bit number; for values larger than this, use decimal Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
CareResponsibility		0..*	string	Element id FamilySituation.CareResponsibility Short description CareResponsibility Definition The activities the patient carries out to care for a dependent family member. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
CommentFamilySituation		0..1	string	Element id FamilySituation.CommentFamilySituation Short description CommentFamilySituation Definition A comment on the family situation. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
Child		0..*	BackboneElement	Element id FamilySituation.Child Short description Child Definition Container of the Child concept. This container contains all data elements of the Child concept. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	There are no (further) constraints on this element Element id FamilySituation.Child.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id FamilySituation.Child.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id FamilySituation.Child.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
DateOfBirth		0..1	dateTime	Element id FamilySituation.Child.DateOfBirth Short description DateOfBirth Definition The child’s date of birth. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
LivingAtHome		0..1	boolean	Element id FamilySituation.Child.LivingAtHome Short description LivingAtHome Definition An indication stating whether the child lives at home. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
CommentChild		0..1	string	Element id FamilySituation.Child.CommentChild Short description CommentChild Definition A comment on the childs family situation. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

FamilySituation		0..*
FamilySituation.MaritalStatus	Reference(HdBe-MaritalStatus)	0..1
FamilySituation.FamilyComposition	CodeableConcept	0..1
FamilySituation.NumberOfChildren	positiveInt	0..1
FamilySituation.NumberOfChildrenLivingAtHome	positiveInt	0..1
FamilySituation.CareResponsibility	string	0..*
FamilySituation.CommentFamilySituation	string	0..1
FamilySituation.Child	BackboneElement	0..*
FamilySituation.Child.DateOfBirth	dateTime	0..1
FamilySituation.Child.LivingAtHome	boolean	0..1
FamilySituation.Child.CommentChild	string	0..1

FamilySituation
Definition	Root concept of the FamilySituation information model. This concept contains all data elements of the FamilySituation information model.
Cardinality	0...*
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
FamilySituation.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
FamilySituation.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
FamilySituation.MaritalStatus
Definition	Patient’s marital status.
Cardinality	0...1
Type	Reference(HdBe-MaritalStatus)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
FamilySituation.FamilyComposition
Definition	The family composition describes the patient’s home situation and the form of cohabitation. A family can consist of one or more people.
Cardinality	0...1
Type	CodeableConcept
Binding	FamilyComposition codes FamilyComposition (extensible)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
FamilySituation.NumberOfChildren
Definition	The number of children the patient has. Children in the context of this information model include step children, foster children, biological and adopted children.
Cardinality	0...1
Type	positiveInt
Comments	32 bit number; for values larger than this, use decimal
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
FamilySituation.NumberOfChildrenLivingAtHome
Definition	The number of children living at home with the patient.
Cardinality	0...1
Type	positiveInt
Comments	32 bit number; for values larger than this, use decimal
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
FamilySituation.CareResponsibility
Definition	The activities the patient carries out to care for a dependent family member.
Cardinality	0...*
Type	string
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
FamilySituation.CommentFamilySituation
Definition	A comment on the family situation.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
FamilySituation.Child
Definition	Container of the Child concept. This container contains all data elements of the Child concept.
Cardinality	0...*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
FamilySituation.Child.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
FamilySituation.Child.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
FamilySituation.Child.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
FamilySituation.Child.DateOfBirth
Definition	The child’s date of birth.
Cardinality	0...1
Type	dateTime
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
FamilySituation.Child.LivingAtHome
Definition	An indication stating whether the child lives at home.
Cardinality	0...1
Type	boolean
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
FamilySituation.Child.CommentChild
Definition	A comment on the childs family situation.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a

Example instances

[CBB name]
[Concept name ]	[example value]

// example of NameInformation

## Example instances

| NameInformation      |                   |
|----------------------|-------------------|
| FirstNames | Johanna Petronella Maria   
| Initials | J.P.M. 
| GivenName | Jo 
| NameUsage | Geslachtsnaam partner gevolgd door eigen geslachtsnaam
| LastName.Prefix | van
| LastName.LastName | Putten
| LastNamePartner.PartnerPrefix | van der
| LastNamePartner.PartnerLastName | Giessen
| Titles |

zib [zib name + version](https://zibs.nl/wiki/[zib name + version(release)]) difference

Concept	Category	Description
`[element.path]`	[category of change]	[Description of change]([Reference to ticket/issue/zulip chat using MarkDown link])

Terminology Bindings

Path	Name	Strength	URL
FamilyComposition	FamilyComposition	extensible	https://fhir.healthdata.be/ValueSet/FamilyComposition