Related Person Logical Model - Definitions - Starter FHIR Implementation Guide v1.0.1

Starter FHIR Implementation Guide, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/Starter-FHIR-IG/ and changes regularly. See the Directory of published versions

Logical Model: RelatedPersonLogicalModel - Detailed Descriptions

Active as of 2024-11-17

Definitions for the RelatedPersonLogicalModel logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. RelatedPersonLogicalModel
Definition	Exchange requirements example for the RelatedPerson Resource.
Short	Related Person Logical Model
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. RelatedPersonLogicalModel.name
Definition	Patient name
Short	Name
Control	1..*
Type	BackboneElement
Must Support	true
4. RelatedPersonLogicalModel.name.firstName
Definition	Person first name
Short	First name
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. RelatedPersonLogicalModel.name.middleName
Definition	Person middle name
Short	Middle name
Control	0..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. RelatedPersonLogicalModel.relationshipType
Definition	How is the person related to the patient
Short	Relationship type
Control	1..1
Binding	The codes SHOULD be taken from v3 Code System RoleCode (preferred to `http://terminology.hl7.org/ValueSet/v3-RoleCode`)
Type	CodeableConcept
Must Support	true
10. RelatedPersonLogicalModel.maritalStatus
Definition	Related person marital status
Short	Marital status
Control	0..1
Type	BackboneElement
Must Support	true
12. RelatedPersonLogicalModel.maritalStatus.status
Definition	A marital status
Short	Status
Control	1..1
Binding	Unless not suitable, these codes SHALL be taken from Marital Status Codes (extensible to `http://hl7.org/fhir/ValueSet/marital-status`)
Type	CodeableConcept
14. RelatedPersonLogicalModel.maritalStatus.effectiveDate
Definition	Date when status came into effect
Short	Effective date
Control	1..1
Type	date
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. RelatedPersonLogicalModel
Definition	Exchange requirements example for the RelatedPerson Resource. Base definition for all elements in a resource.
Short	Related Person Logical ModelBase for all elements
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. RelatedPersonLogicalModel.name
Definition	Patient name
Short	Name
Control	1..*
Type	BackboneElement
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
4. RelatedPersonLogicalModel.name.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).
Short	Extensions that cannot be ignored even if unrecognized
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.
Control	0..*
Type	Extension
Is Modifier	true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary	true
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.
Alternate Names	extensions, user content, modifiers
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())
6. RelatedPersonLogicalModel.name.firstName
Definition	Person first name
Short	First name
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. RelatedPersonLogicalModel.name.middleName
Definition	Person middle name
Short	Middle name
Control	0..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. RelatedPersonLogicalModel.relationshipType
Definition	How is the person related to the patient
Short	Relationship type
Control	1..1
Binding	The codes SHOULD be taken from v3 Code System RoleCode (preferred to `http://terminology.hl7.org/ValueSet/v3-RoleCode`)
Type	CodeableConcept
Must Support	true
Summary	true
12. RelatedPersonLogicalModel.maritalStatus
Definition	Related person marital status
Short	Marital status
Control	0..1
Type	BackboneElement
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. RelatedPersonLogicalModel.maritalStatus.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).
Short	Extensions that cannot be ignored even if unrecognized
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.
Control	0..*
Type	Extension
Is Modifier	true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary	true
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.
Alternate Names	extensions, user content, modifiers
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())
16. RelatedPersonLogicalModel.maritalStatus.status
Definition	A marital status
Short	Status
Control	1..1
Binding	Unless not suitable, these codes SHALL be taken from Marital Status Codes (extensible to `http://hl7.org/fhir/ValueSet/marital-status`)
Type	CodeableConcept
18. RelatedPersonLogicalModel.maritalStatus.effectiveDate
Definition	Date when status came into effect
Short	Effective date
Control	1..1
Type	date
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. RelatedPersonLogicalModel
Definition	Exchange requirements example for the RelatedPerson Resource.
Short	Related Person Logical Model
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. RelatedPersonLogicalModel.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. RelatedPersonLogicalModel.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.
Short	Additional content defined by implementations
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.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
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()`)
Slicing	This element introduces a set of slices on `RelatedPersonLogicalModel.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. RelatedPersonLogicalModel.name
Definition	Patient name
Short	Name
Control	1..*
Type	BackboneElement
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. RelatedPersonLogicalModel.name.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
10. RelatedPersonLogicalModel.name.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.
Short	Additional content defined by implementations
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.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
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()`)
Slicing	This element introduces a set of slices on `RelatedPersonLogicalModel.name.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
12. RelatedPersonLogicalModel.name.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).
Short	Extensions that cannot be ignored even if unrecognized
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.
Control	0..*
Type	Extension
Is Modifier	true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary	true
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.
Alternate Names	extensions, user content, modifiers
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()`)
14. RelatedPersonLogicalModel.name.firstName
Definition	Person first name
Short	First name
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. RelatedPersonLogicalModel.name.middleName
Definition	Person middle name
Short	Middle name
Control	0..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. RelatedPersonLogicalModel.relationshipType
Definition	How is the person related to the patient
Short	Relationship type
Control	1..1
Binding	The codes SHOULD be taken from v3 Code System RoleCode (preferred to `http://terminology.hl7.org/ValueSet/v3-RoleCode`)
Type	CodeableConcept
Must Support	true
Summary	true
20. RelatedPersonLogicalModel.maritalStatus
Definition	Related person marital status
Short	Marital status
Control	0..1
Type	BackboneElement
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. RelatedPersonLogicalModel.maritalStatus.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
24. RelatedPersonLogicalModel.maritalStatus.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.
Short	Additional content defined by implementations
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.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
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()`)
Slicing	This element introduces a set of slices on `RelatedPersonLogicalModel.maritalStatus.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
26. RelatedPersonLogicalModel.maritalStatus.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).
Short	Extensions that cannot be ignored even if unrecognized
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.
Control	0..*
Type	Extension
Is Modifier	true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary	true
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.
Alternate Names	extensions, user content, modifiers
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()`)
28. RelatedPersonLogicalModel.maritalStatus.status
Definition	A marital status
Short	Status
Control	1..1
Binding	Unless not suitable, these codes SHALL be taken from Marital Status Codes (extensible to `http://hl7.org/fhir/ValueSet/marital-status`)
Type	CodeableConcept
30. RelatedPersonLogicalModel.maritalStatus.effectiveDate
Definition	Date when status came into effect
Short	Effective date
Control	1..1
Type	date
Primitive Value	This primitive element may be present, or absent, or replaced by an extension