Patient's address book - Definitions - International Patient Summary Implementation Guide v2.0.0

International Patient Summary Implementation Guide
2.0.0 - STU 2 International flag

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/costateixeira/fhir-ips/ and changes regularly. See the Directory of published versions

Logical Model: AddressBookFeature - Detailed Descriptions

Page standards status: Trial-use

Maturity Level: 2

Definitions for the AddressBookFeature logical model.

Key Elements Table
Differential Elements Table
Snapshot Elements Table

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

0. AddressBookFeature
Definition	Patient's address book
Short	Patient's address book
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. AddressBookFeature.preferredHealthcareProviders
Definition	Preferred Healthcare Providers
Short	Preferred Healthcare Providers
Comments	Required if known
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/HealthcareProvider
4. AddressBookFeature.othersAddressDetails
Definition	Others Address Details
Short	Others Address Details
Comments	Optional
Control	0..*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. AddressBookFeature.othersAddressDetails.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
8. AddressBookFeature.othersAddressDetails.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 `AddressBookFeature.othersAddressDetails.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. AddressBookFeature.othersAddressDetails.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())
12. AddressBookFeature.othersAddressDetails.addressee
Definition	Addressee
Short	Addressee
Comments	Required (Exceptions allowed)
Control	0..1
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. AddressBookFeature.othersAddressDetails.addressee.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
16. AddressBookFeature.othersAddressDetails.addressee.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 `AddressBookFeature.othersAddressDetails.addressee.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
18. AddressBookFeature.othersAddressDetails.addressee.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())
20. AddressBookFeature.othersAddressDetails.addressee.role
Definition	Role
Short	Role
Comments	Required if known
Control	0..*
Type	CodeableConcept
22. AddressBookFeature.othersAddressDetails.addressee.name
Definition	Name
Short	Name
Comments	Required (Exceptions allowed)
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/PersonName
24. AddressBookFeature.othersAddressDetails.addressee.address
Definition	Address
Short	Address
Comments	Optional
Control	0..*
Type	Address
26. AddressBookFeature.othersAddressDetails.addressee.telecom
Definition	Telecom
Short	Telecom
Comments	Required if known
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/Telecom
28. AddressBookFeature.othersAddressDetails.addressee.healthcareProvider
Definition	Healthcare Provider
Short	Healthcare Provider
Comments	Optional
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/HealthcareProvider
30. AddressBookFeature.othersAddressDetails.addressee.addressBook
Definition	Patient's Address book
Short	Patient's Address book
Comments	Optional
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/AddressBook

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

0. AddressBookFeature
Definition	Patient's address book
Short	Patient's address book
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. AddressBookFeature.preferredHealthcareProviders
Definition	Preferred Healthcare Providers
Short	Preferred Healthcare Providers
Comments	Required if known
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/HealthcareProvider
4. AddressBookFeature.othersAddressDetails
Definition	Others Address Details
Short	Others Address Details
Comments	Optional
Control	0..*
Type	BackboneElement
6. AddressBookFeature.othersAddressDetails.addressee
Definition	Addressee
Short	Addressee
Comments	Required (Exceptions allowed)
Control	0..1
Type	BackboneElement
8. AddressBookFeature.othersAddressDetails.addressee.role
Definition	Role
Short	Role
Comments	Required if known
Control	0..*
Type	CodeableConcept
10. AddressBookFeature.othersAddressDetails.addressee.name
Definition	Name
Short	Name
Comments	Required (Exceptions allowed)
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/PersonName
12. AddressBookFeature.othersAddressDetails.addressee.address
Definition	Address
Short	Address
Comments	Optional
Control	0..*
Type	Address
14. AddressBookFeature.othersAddressDetails.addressee.telecom
Definition	Telecom
Short	Telecom
Comments	Required if known
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/Telecom
16. AddressBookFeature.othersAddressDetails.addressee.healthcareProvider
Definition	Healthcare Provider
Short	Healthcare Provider
Comments	Optional
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/HealthcareProvider
18. AddressBookFeature.othersAddressDetails.addressee.addressBook
Definition	Patient's Address book
Short	Patient's Address book
Comments	Optional
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/AddressBook

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

0. AddressBookFeature
Definition	Patient's address book
Short	Patient's address book
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. AddressBookFeature.preferredHealthcareProviders
Definition	Preferred Healthcare Providers
Short	Preferred Healthcare Providers
Comments	Required if known
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/HealthcareProvider
4. AddressBookFeature.othersAddressDetails
Definition	Others Address Details
Short	Others Address Details
Comments	Optional
Control	0..*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. AddressBookFeature.othersAddressDetails.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
8. AddressBookFeature.othersAddressDetails.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 `AddressBookFeature.othersAddressDetails.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. AddressBookFeature.othersAddressDetails.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()`)
12. AddressBookFeature.othersAddressDetails.addressee
Definition	Addressee
Short	Addressee
Comments	Required (Exceptions allowed)
Control	0..1
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. AddressBookFeature.othersAddressDetails.addressee.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
16. AddressBookFeature.othersAddressDetails.addressee.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 `AddressBookFeature.othersAddressDetails.addressee.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
18. AddressBookFeature.othersAddressDetails.addressee.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()`)
20. AddressBookFeature.othersAddressDetails.addressee.role
Definition	Role
Short	Role
Comments	Required if known
Control	0..*
Type	CodeableConcept
22. AddressBookFeature.othersAddressDetails.addressee.name
Definition	Name
Short	Name
Comments	Required (Exceptions allowed)
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/PersonName
24. AddressBookFeature.othersAddressDetails.addressee.address
Definition	Address
Short	Address
Comments	Optional
Control	0..*
Type	Address
26. AddressBookFeature.othersAddressDetails.addressee.telecom
Definition	Telecom
Short	Telecom
Comments	Required if known
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/Telecom
28. AddressBookFeature.othersAddressDetails.addressee.healthcareProvider
Definition	Healthcare Provider
Short	Healthcare Provider
Comments	Optional
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/HealthcareProvider
30. AddressBookFeature.othersAddressDetails.addressee.addressBook
Definition	Patient's Address book
Short	Patient's Address book
Comments	Optional
Control	0..*
Type	http://hl7.org/fhir/uv/ips/StructureDefinition/AddressBook

IG © 2020+ HL7 International / Patient Care. Package hl7.fhir.uv.ips#2.0.0 based on FHIR 4.0.1. Generated 2024-12-29
Links: Table of Contents | QA Report | Version History | | Propose a change