FHIR IG Statistics: StructureDefinition/AddressBookFeature
Resources that use this resource
| StructureDefinition |
| ISO27269 | ISO 27269 IPS |
Resources that this resource uses
Narrative
Note: links and images are rebased to the (stated) source
Source
{
"resourceType": "StructureDefinition",
"id": "AddressBookFeature",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-be-target"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pc"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/ips/ImplementationGuide/hl7.fhir.uv.ips"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/ips/ImplementationGuide/hl7.fhir.uv.ips"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/ips/StructureDefinition/AddressBookFeature",
"version": "2.0.0",
"name": "AddressBookFeature",
"title": "Patient's address book",
"status": "active",
"date": "2025-05-05T17:00:38+00:00",
"publisher": "HL7 International / Patient Care",
"contact": [
{
"name": "HL7 International / Patient Care",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare"
}
]
}
],
"description": "Patient's address book",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/fhir/uv/ips/StructureDefinition/AddressBookFeature",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "AddressBookFeature",
"path": "AddressBookFeature",
"short": "Patient's address book",
"definition": "Patient's address book",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "AddressBookFeature.preferredHealthcareProviders",
"path": "AddressBookFeature.preferredHealthcareProviders",
"short": "Preferred Healthcare Providers",
"definition": "Preferred Healthcare Providers",
"comment": "Required if known",
"min": 0,
"max": "*",
"base": {
"path": "AddressBookFeature.preferredHealthcareProviders",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/uv/ips/StructureDefinition/HealthcareProvider"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails",
"path": "AddressBookFeature.othersAddressDetails",
"short": "Others Address Details",
"definition": "Others Address Details",
"comment": "Optional",
"min": 0,
"max": "*",
"base": {
"path": "AddressBookFeature.othersAddressDetails",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.id",
"path": "AddressBookFeature.othersAddressDetails.id",
"representation": [
"xmlAttr"
],
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.extension",
"path": "AddressBookFeature.othersAddressDetails.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.modifierExtension",
"path": "AddressBookFeature.othersAddressDetails.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee",
"path": "AddressBookFeature.othersAddressDetails.addressee",
"short": "Addressee",
"definition": "Addressee",
"comment": "Required (Exceptions allowed)",
"min": 0,
"max": "1",
"base": {
"path": "AddressBookFeature.othersAddressDetails.addressee",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.id",
"path": "AddressBookFeature.othersAddressDetails.addressee.id",
"representation": [
"xmlAttr"
],
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.extension",
"path": "AddressBookFeature.othersAddressDetails.addressee.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.modifierExtension",
"path": "AddressBookFeature.othersAddressDetails.addressee.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.role",
"path": "AddressBookFeature.othersAddressDetails.addressee.role",
"short": "Role",
"definition": "Role",
"comment": "Required if known",
"min": 0,
"max": "*",
"base": {
"path": "AddressBookFeature.othersAddressDetails.addressee.role",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.name",
"path": "AddressBookFeature.othersAddressDetails.addressee.name",
"short": "Name",
"definition": "Name",
"comment": "Required (Exceptions allowed)",
"min": 0,
"max": "*",
"base": {
"path": "AddressBookFeature.othersAddressDetails.addressee.name",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/uv/ips/StructureDefinition/PersonName"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.address",
"path": "AddressBookFeature.othersAddressDetails.addressee.address",
"short": "Address",
"definition": "Address",
"comment": "Optional",
"min": 0,
"max": "*",
"base": {
"path": "AddressBookFeature.othersAddressDetails.addressee.address",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Address"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.telecom",
"path": "AddressBookFeature.othersAddressDetails.addressee.telecom",
"short": "Telecom",
"definition": "Telecom",
"comment": "Required if known",
"min": 0,
"max": "*",
"base": {
"path": "AddressBookFeature.othersAddressDetails.addressee.telecom",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/uv/ips/StructureDefinition/Telecom"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.healthcareProvider",
"path": "AddressBookFeature.othersAddressDetails.addressee.healthcareProvider",
"short": "Healthcare Provider",
"definition": "Healthcare Provider",
"comment": "Optional",
"min": 0,
"max": "*",
"base": {
"path": "AddressBookFeature.othersAddressDetails.addressee.healthcareProvider",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/uv/ips/StructureDefinition/HealthcareProvider"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.addressBook",
"path": "AddressBookFeature.othersAddressDetails.addressee.addressBook",
"short": "Patient's Address book",
"definition": "Patient's Address book",
"comment": "Optional",
"min": 0,
"max": "*",
"base": {
"path": "AddressBookFeature.othersAddressDetails.addressee.addressBook",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/uv/ips/StructureDefinition/AddressBook"
}
]
}
]
},
"differential": {
"element": [
{
"id": "AddressBookFeature",
"path": "AddressBookFeature",
"short": "Patient's address book",
"definition": "Patient's address book"
},
{
"id": "AddressBookFeature.preferredHealthcareProviders",
"path": "AddressBookFeature.preferredHealthcareProviders",
"short": "Preferred Healthcare Providers",
"definition": "Preferred Healthcare Providers",
"comment": "Required if known",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/fhir/uv/ips/StructureDefinition/HealthcareProvider"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails",
"path": "AddressBookFeature.othersAddressDetails",
"short": "Others Address Details",
"definition": "Others Address Details",
"comment": "Optional",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee",
"path": "AddressBookFeature.othersAddressDetails.addressee",
"short": "Addressee",
"definition": "Addressee",
"comment": "Required (Exceptions allowed)",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.role",
"path": "AddressBookFeature.othersAddressDetails.addressee.role",
"short": "Role",
"definition": "Role",
"comment": "Required if known",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.name",
"path": "AddressBookFeature.othersAddressDetails.addressee.name",
"short": "Name",
"definition": "Name",
"comment": "Required (Exceptions allowed)",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/fhir/uv/ips/StructureDefinition/PersonName"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.address",
"path": "AddressBookFeature.othersAddressDetails.addressee.address",
"short": "Address",
"definition": "Address",
"comment": "Optional",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.telecom",
"path": "AddressBookFeature.othersAddressDetails.addressee.telecom",
"short": "Telecom",
"definition": "Telecom",
"comment": "Required if known",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/fhir/uv/ips/StructureDefinition/Telecom"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.healthcareProvider",
"path": "AddressBookFeature.othersAddressDetails.addressee.healthcareProvider",
"short": "Healthcare Provider",
"definition": "Healthcare Provider",
"comment": "Optional",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/fhir/uv/ips/StructureDefinition/HealthcareProvider"
}
]
},
{
"id": "AddressBookFeature.othersAddressDetails.addressee.addressBook",
"path": "AddressBookFeature.othersAddressDetails.addressee.addressBook",
"short": "Patient's Address book",
"definition": "Patient's Address book",
"comment": "Optional",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/fhir/uv/ips/StructureDefinition/AddressBook"
}
]
}
]
}
}
AddressBookFeature 
preferredHealthcareProviders 
othersAddressDetails 
FHIR