{
"description": "Belgain federal profile on address, to provide the possibility in the 'line' element to provide a seperate streetname, housenumber and postal box. It is always RECOMMENDED to give these elements seperately.",
"_filename": "structuredefinition-be-address.json",
"package_name": "ehealthplatform.be.r4.federalprofiles",
"date": null,
"derivation": "constraint",
"publisher": null,
"fhirVersion": "4.0.0",
"name": "BeAddress",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD",
"identity": "servd"
}, {
"uri": "http://w3.org/vcard",
"name": "vCard Mapping",
"identity": "vcard"
} ],
"abstract": false,
"type": "Address",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.1.15-beta",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Address",
"min": 0,
"definition": "An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.",
"isModifier": false,
"short": "An address expressed using postal conventions (as opposed to GPS or other location definition formats)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD",
"identity": "v2"
}, {
"map": "AD",
"identity": "rim"
}, {
"map": "Address",
"identity": "servd"
} ],
"max": "*",
"id": "Address",
"condition": [ "ele-1" ],
"comment": "Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource).\r\n\r\nSpecial remarks for KMEHR users:\r\n\r\nNote when .use and .type are used they SHALL use the FHIR defined valuesets as per their required binding level in the FHIR specification. In a KMEHR address, the use was defined by CD-ADDRESS but those values can be found in the FHIR valueset.\r\nKMEHR values 'careadress', 'other' and 'vacation' are not directly present in the FHIR address-use table but can be mapped to the value 'temp' in FHIR. In those cases, it is RECOMMENDED to also add a .period.\r\nIn KMEHR, an address might be expressed using free text or a totally structured approach where the streetname and housenumber are put in separate fields. FHIR prefers a more pragmatic approach where the ‘text’ element is used to print on labels. Also, streetname and number are not separate fields as in KMEHR but in a structural approach are given as one or moren ‘line’ elements. It is however RECOMMENDED to use the Streetname, Housenumber and Postbox extensions to express them seperately.\r\nNote the FHIR address also allows to optionally define whether the address is a physical, postal or ‘both’ address using the .type field.",
"base": {
"max": "*",
"min": 0,
"path": "Address"
}
}, {
"path": "Address.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Address.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Address.extension",
"min": 0,
"definition": "The Human Language of the item. Can be used to express the same address in multiple languages (e.g. in a Brussels setting)",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Address.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Address.extension",
"min": 0,
"definition": "The Human Language of the item.",
"isModifier": false,
"short": "Human Language for the item",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/language" ]
} ],
"sliceName": "language",
"max": "*",
"id": "Address.extension:language",
"comment": "This is used where an item may repeat to indicate the language of each repeat.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Address.extension.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Address.extension:language.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Address.extension.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "Address.extension:language.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Address.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"isModifier": false,
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/language",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Address.extension:language.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"isSummary": false
}, {
"path": "Address.extension.valueCode",
"min": 0,
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"isModifier": false,
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "Address.extension:language.valueCode",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
}, {
"path": "Address.use",
"requirements": "Allows an appropriate address to be chosen from a list of many.",
"min": 0,
"definition": "The purpose of this address.",
"isModifier": true,
"short": "home | work | temp | old | billing - purpose of this address",
"mapping": [ {
"map": "XAD.7",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./AddressPurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/address-use|4.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AddressUse"
} ],
"description": "The use of an address."
},
"max": "1",
"id": "Address.use",
"comment": "Applications can assume that an address is current unless it explicitly says that it is temporary or old.",
"example": [ {
"label": "General",
"valueCode": "home"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one",
"isSummary": true
}, {
"path": "Address.type",
"min": 0,
"definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
"isModifier": false,
"short": "postal | physical | both",
"mapping": [ {
"map": "XAD.18",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "address type parameter",
"identity": "vcard"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/address-type|4.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AddressType"
} ],
"description": "The type of an address (physical / postal)."
},
"max": "1",
"id": "Address.type",
"comment": "The definition of Address states that \"address is intended to describe postal addresses, not physical locations\". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource).",
"example": [ {
"label": "General",
"valueCode": "both"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.type"
},
"isSummary": true
}, {
"path": "Address.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.",
"isModifier": false,
"short": "Text representation of the address",
"mapping": [ {
"map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
}, {
"map": "address label parameter",
"identity": "vcard"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Address.text",
"comment": "Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.",
"example": [ {
"label": "General",
"valueString": "137 Nowhere Street, Erewhon 9132"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.text"
},
"isSummary": true
}, {
"path": "Address.line",
"min": 0,
"definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. It is always RECOMMENDED to give these elements seperately using the defined extensions.",
"isModifier": false,
"short": "Street name, number, direction & P.O. Box etc.",
"mapping": [ {
"map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)",
"identity": "v2"
}, {
"map": "AD.part[parttype = AL]",
"identity": "rim"
}, {
"map": "street",
"identity": "vcard"
}, {
"map": "./StreetAddress (newline delimitted)",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Address.line",
"example": [ {
"label": "General",
"valueString": "137 Nowhere Street"
} ],
"orderMeaning": "The order in which lines should appear in an address label",
"base": {
"max": "*",
"min": 0,
"path": "Address.line"
},
"isSummary": true
}, {
"path": "Address.line.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Address.line.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Address.line.extension",
"min": 0,
"definition": "RECOMMENDED to use these extensions to define address elements.",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Address.line.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Address.line.extension",
"min": 0,
"definition": "streetName.",
"isModifier": false,
"short": "streetName",
"mapping": [ {
"map": "ADXP[partType=STR]",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName" ]
} ],
"sliceName": "Streetname",
"max": "*",
"id": "Address.line.extension:Streetname",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Address.line.extension.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Address.line.extension:Streetname.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Address.line.extension.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "Address.line.extension:Streetname.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Address.line.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"isModifier": false,
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Address.line.extension:Streetname.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"isSummary": false
}, {
"path": "Address.line.extension.valueString",
"min": 0,
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"isModifier": false,
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Address.line.extension:Streetname.valueString",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Address.line.extension",
"min": 0,
"definition": "The number of a building, house or lot alongside the street. Also known as \"primary street number\". This does not number the street but rather the building.",
"isModifier": false,
"short": "houseNumber",
"mapping": [ {
"map": "ADXP[partType=BNR]",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber" ]
} ],
"sliceName": "Housenumber",
"max": "*",
"id": "Address.line.extension:Housenumber",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Address.line.extension.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Address.line.extension:Housenumber.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Address.line.extension.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "Address.line.extension:Housenumber.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Address.line.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"isModifier": false,
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Address.line.extension:Housenumber.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"isSummary": false
}, {
"path": "Address.line.extension.valueString",
"min": 0,
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"isModifier": false,
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Address.line.extension:Housenumber.valueString",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Address.line.extension",
"min": 0,
"definition": "A numbered box located in a post station.",
"isModifier": false,
"short": "postBox",
"mapping": [ {
"map": "ADXP[partType=POB]",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox" ]
} ],
"sliceName": "Postbox",
"max": "*",
"id": "Address.line.extension:Postbox",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Address.line.extension.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Address.line.extension:Postbox.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Address.line.extension.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "Address.line.extension:Postbox.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Address.line.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"isModifier": false,
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Address.line.extension:Postbox.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"isSummary": false
}, {
"path": "Address.line.extension.valueString",
"min": 0,
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"isModifier": false,
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Address.line.extension:Postbox.valueString",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
}, {
"path": "Address.line.value",
"min": 0,
"definition": "The actual value",
"isModifier": false,
"short": "Primitive value for string",
"type": [ {
"_code": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:string"
} ]
},
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Address.line.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"path": "Address.city",
"min": 0,
"definition": "The name of the city, town, suburb, village or other community or delivery center.",
"isModifier": false,
"short": "Name of city, town etc.",
"mapping": [ {
"map": "XAD.3",
"identity": "v2"
}, {
"map": "AD.part[parttype = CTY]",
"identity": "rim"
}, {
"map": "locality",
"identity": "vcard"
}, {
"map": "./Jurisdiction",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Municpality" ],
"max": "1",
"id": "Address.city",
"example": [ {
"label": "General",
"valueString": "Erewhon"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.city"
},
"isSummary": true
}, {
"path": "Address.district",
"min": 0,
"definition": "The name of the administrative area (county).",
"isModifier": false,
"short": "District name (aka county)",
"mapping": [ {
"map": "XAD.9",
"identity": "v2"
}, {
"map": "AD.part[parttype = CNT | CPA]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "County" ],
"max": "1",
"id": "Address.district",
"comment": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.",
"example": [ {
"label": "General",
"valueString": "Madison"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.district"
},
"isSummary": true
}, {
"path": "Address.state",
"min": 0,
"definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).",
"isModifier": false,
"short": "Sub-unit of country (abbreviations ok)",
"mapping": [ {
"map": "XAD.4",
"identity": "v2"
}, {
"map": "AD.part[parttype = STA]",
"identity": "rim"
}, {
"map": "region",
"identity": "vcard"
}, {
"map": "./Region",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Province", "Territory" ],
"max": "1",
"id": "Address.state",
"base": {
"max": "1",
"min": 0,
"path": "Address.state"
},
"isSummary": true
}, {
"path": "Address.postalCode",
"min": 0,
"definition": "A postal code designating a region defined by the postal service.",
"isModifier": false,
"short": "Postal code for area",
"mapping": [ {
"map": "XAD.5",
"identity": "v2"
}, {
"map": "AD.part[parttype = ZIP]",
"identity": "rim"
}, {
"map": "code",
"identity": "vcard"
}, {
"map": "./PostalIdentificationCode",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Zip" ],
"max": "1",
"id": "Address.postalCode",
"example": [ {
"label": "General",
"valueString": "9132"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.postalCode"
},
"isSummary": true
}, {
"path": "Address.country",
"min": 0,
"definition": "Country - a nation as commonly understood or generally accepted.\r\nConcerning the codification of the country, the FHIR specification defines its country field as a string and suggests using a ISO 3166 2 or 3 letter codes.\r\nAs that 2-letter format is also the standard in a KMEHR address, it is hence RECOMMENDED to codify the country in the same way as in KMEHR.",
"isModifier": false,
"short": "Country (e.g. can be ISO 3166 2 or 3 letter code)",
"mapping": [ {
"map": "XAD.6",
"identity": "v2"
}, {
"map": "AD.part[parttype = CNT]",
"identity": "rim"
}, {
"map": "country",
"identity": "vcard"
}, {
"map": "./Country",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Address.country",
"comment": "ISO 3166 3 letter codes can be used in place of a human readable country name.",
"base": {
"max": "1",
"min": 0,
"path": "Address.country"
},
"isSummary": true
}, {
"path": "Address.period",
"requirements": "Allows addresses to be placed in historical context.",
"min": 0,
"definition": "Time period when address was/is in use.",
"isModifier": false,
"short": "Time period when address was/is in use",
"mapping": [ {
"map": "XAD.12 / XAD.13 + XAD.14",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Address.period",
"example": [ {
"label": "General",
"valuePeriod": {
"end": "2010-07-01",
"start": "2010-03-23"
}
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.period"
},
"isSummary": true
} ]
},
"status": "active",
"id": "b0673738-eb98-4eb8-b019-bf4fd4e35972",
"kind": "complex-type",
"url": "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-address",
"version": "1.0.0",
"differential": {
"element": [ {
"id": "Address",
"path": "Address",
"comment": "Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource).\r\n\r\nSpecial remarks for KMEHR users:\r\n\r\nNote when .use and .type are used they SHALL use the FHIR defined valuesets as per their required binding level in the FHIR specification. In a KMEHR address, the use was defined by CD-ADDRESS but those values can be found in the FHIR valueset.\r\nKMEHR values 'careadress', 'other' and 'vacation' are not directly present in the FHIR address-use table but can be mapped to the value 'temp' in FHIR. In those cases, it is RECOMMENDED to also add a .period.\r\nIn KMEHR, an address might be expressed using free text or a totally structured approach where the streetname and housenumber are put in separate fields. FHIR prefers a more pragmatic approach where the ‘text’ element is used to print on labels. Also, streetname and number are not separate fields as in KMEHR but in a structural approach are given as one or moren ‘line’ elements. It is however RECOMMENDED to use the Streetname, Housenumber and Postbox extensions to express them seperately.\r\nNote the FHIR address also allows to optionally define whether the address is a physical, postal or ‘both’ address using the .type field."
}, {
"id": "Address.extension",
"path": "Address.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"definition": "The Human Language of the item. Can be used to express the same address in multiple languages (e.g. in a Brussels setting)"
}, {
"id": "Address.extension:language",
"min": 0,
"path": "Address.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/language" ]
} ],
"sliceName": "language"
}, {
"id": "Address.line",
"path": "Address.line",
"definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. It is always RECOMMENDED to give these elements seperately using the defined extensions."
}, {
"id": "Address.line.extension",
"path": "Address.line.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"definition": "RECOMMENDED to use these extensions to define address elements."
}, {
"id": "Address.line.extension:Streetname",
"path": "Address.line.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName" ]
} ],
"sliceName": "Streetname"
}, {
"id": "Address.line.extension:Streetname.value[x]",
"path": "Address.line.extension.value[x]",
"type": [ {
"code": "string"
} ]
}, {
"id": "Address.line.extension:Housenumber",
"path": "Address.line.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber" ]
} ],
"sliceName": "Housenumber"
}, {
"id": "Address.line.extension:Housenumber.value[x]",
"path": "Address.line.extension.value[x]",
"type": [ {
"code": "string"
} ]
}, {
"id": "Address.line.extension:Postbox",
"path": "Address.line.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox" ]
} ],
"sliceName": "Postbox"
}, {
"id": "Address.line.extension:Postbox.value[x]",
"path": "Address.line.extension.value[x]",
"type": [ {
"code": "string"
} ]
}, {
"id": "Address.country",
"path": "Address.country",
"definition": "Country - a nation as commonly understood or generally accepted.\r\nConcerning the codification of the country, the FHIR specification defines its country field as a string and suggests using a ISO 3166 2 or 3 letter codes.\r\nAs that 2-letter format is also the standard in a KMEHR address, it is hence RECOMMENDED to codify the country in the same way as in KMEHR."
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Address"
}