HL7® Serious Med FHIR® Core Implementation Guide
1.0.0 - ci-build

HL7® Serious Med FHIR® Core Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: SmAddress - Detailed Descriptions

Draft as of 2024-11-11

Definitions for the sm-address data type profile.

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

0. Address
Definition

使用邮政规范表达的地址(相对于GPS或其他位置定义格式)。这种data type可用于传达投递邮件的位址,以及用于访问可能对邮件投递无效的位置,这世界定义了各种邮政地址格式。

Short使用邮政规范表达的地址(相对于GPS或其他位置定义格式)
Comments

注意:地址的目的是描述用于管理目的之邮政地址,而不是描述绝对的地理座标。邮政地址经常被用作实体位置的代表(亦可见Locationresource)。

2. Address.id
Definition

resource中资料项目的唯一ID(用于内部参照)。这可以是任何不含空格的字串。

Short唯一可识别ID,以供资料项目间相互参照。
4. Address.use
Definition

此地址的用途

Shorthome | work | temp | old | billing - 此地址的用途
Comments

应用程序可假定一个地址是目前使用中,除非它明确说它是暂时的或旧的。

BindingThe codes SHALL be taken from AddressUse
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

应填入AddressUse值集中的其中一个代码

Must Supporttrue
Requirements

允许从清单中挑选适当的地址用途

6. Address.type
Definition

区分实际地址(你可以拜访的地址)和邮寄地址(如邮政信箱和转递地址),大多数地址都是这两种。

Shortpostal | physical | both
Comments

地址的定义指出「地址旨在描述邮政地址,而不是实体位置」。但许多应用程序追踪一个地址是否具有双重目的,既是一个可以拜访的地点,亦是一个有效的投递目的地,邮政地址经常被用作实体位置的代表(亦可见Locationresource)。

BindingThe codes SHALL be taken from AddressType
(required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

应填入AddressType值集中的其中一个代码

Must Supporttrue
8. Address.text
Definition

具体说明整个地址,因为它应该显示在邮政标签上,这可替代或与特定的部分一起提供。

Short地址的文字表述
Comments

可以同时提供文字表述和各部分的地址资料项目内容。更新地址的应用程序 必须(SHALL) 确保当文字表述和各部分的地址资料项目内容都存在时,文字表述不包括各部分的地址资料项目内容中没有的内容,意即两者内容会一致。

Requirements

一个可呈现的、未编码的形式。

10. Address.line
Definition

此部分包含门牌号码、公寓号码、街道名称、街道方向、邮政信箱号码、送货提示以及类似的地址信息。

Short路/街
Control0..1
Must Supporttrue
Alternate Names路, 街
12. Address.city
Definition

市、乡、镇、村或其他社区或配送中心的名称。

Short乡/镇/市/区
Must Supporttrue
Alternate Names乡, 镇, 市, 区
14. Address.district
Definition

行政区域(县)的名称

Short县/市
Comments

区(district)有时被称为县(country),但在一些区域(regions),「县(country)」被用来代替市(直辖市),所以县名应该用市名来代替传达。

Must Supporttrue
Alternate Names
16. Address.state
Definition

一个国家的子单位,在联邦组织的国家中拥有有限的主权。如果代码被普遍使用,可使用代码(例如:美国2个字母的州代码)。

Short国家的子单位(缩写也可以)
18. Address.postalCode
Definition

指定一个由邮政服务定义的区域之邮递区号

Short邮递区号
Must Supporttrue
20. Address.postalCode.id
Definition

resource中资料项目的唯一ID(用于内部参照)。这可以是任何不含空格的字串。

Shortxml:id(或JSON格式)。
22. Address.postalCode.value
Definition

实际值

Short邮递区号
24. Address.country
Definition

国家—通常被理解为或普遍被接受的一个国家。

Short国家(例如:ISO 3166的2个或3个字母代码)。
Comments

可用ISO 3166的3个字母代码来代替人类可读的国家名

Must Supporttrue
26. Address.period
Definition

此地址曾经/正在使用的时间区间

Short此地址曾经/正在使用的时间区间
Requirements

允许将地址依时间排放

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

0. Address
Definition

使用邮政规范表达的地址(相对于GPS或其他位置定义格式)。这种data type可用于传达投递邮件的位址,以及用于访问可能对邮件投递无效的位置,这世界定义了各种邮政地址格式。


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.

Short使用邮政规范表达的地址(相对于GPS或其他位置定义格式)An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Comments

注意:地址的目的是描述用于管理目的之邮政地址,而不是描述绝对的地理座标。邮政地址经常被用作实体位置的代表(亦可见Locationresource)。


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 resource).

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Address.id
Definition

resource中资料项目的唯一ID(用于内部参照)。这可以是任何不含空格的字串。


Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short唯一可识别ID,以供资料项目间相互参照。Unique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Address.use
Definition

此地址的用途


The purpose of this address.

Shorthome | work | temp | old | billing - 此地址的用途home | work | temp | old | billing - purpose of this address
Comments

应用程序可假定一个地址是目前使用中,除非它明确说它是暂时的或旧的。


Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

应填入AddressUse值集中的其中一个代码


The use of an address.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

允许从清单中挑选适当的地址用途


Allows an appropriate address to be chosen from a list of many.

Example<br/><b>General</b>:home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Address.type
Definition

区分实际地址(你可以拜访的地址)和邮寄地址(如邮政信箱和转递地址),大多数地址都是这两种。


Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Shortpostal | physical | bothpostal | physical | both
Comments

地址的定义指出「地址旨在描述邮政地址,而不是实体位置」。但许多应用程序追踪一个地址是否具有双重目的,既是一个可以拜访的地点,亦是一个有效的投递目的地,邮政地址经常被用作实体位置的代表(亦可见Locationresource)。


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 resource).

Control0..1
BindingThe codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

应填入AddressType值集中的其中一个代码


The type of an address (physical / postal).

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Example<br/><b>General</b>:both
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Address.text
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.

Short地址的文字表述Text representation of the address
Comments

可以同时提供文字表述和各部分的地址资料项目内容。更新地址的应用程序 必须(SHALL) 确保当文字表述和各部分的地址资料项目内容都存在时,文字表述不包括各部分的地址资料项目内容中没有的内容,意即两者内容会一致。


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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

一个可呈现的、未编码的形式。


A renderable, unencoded form.

Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. 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.

Short路/街Street name, number, direction & P.O. Box etc.
Control0..1*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate Names路, 街
Example<br/><b>General</b>:137 Nowhere Street
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Address.city
Definition

市、乡、镇、村或其他社区或配送中心的名称。


The name of the city, town, suburb, village or other community or delivery center.

Short乡/镇/市/区Name of city, town etc.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesMunicpality, 乡, 镇, 市, 区
Example<br/><b>General</b>:Erewhon
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Address.district
Definition

行政区域(县)的名称


The name of the administrative area (county).

Short县/市District name (aka county)
Comments

区(district)有时被称为县(country),但在一些区域(regions),「县(country)」被用来代替市(直辖市),所以县名应该用市名来代替传达。


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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesCounty, 市
Example<br/><b>General</b>:Madison
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Address.state
Definition

一个国家的子单位,在联邦组织的国家中拥有有限的主权。如果代码被普遍使用,可使用代码(例如:美国2个字母的州代码)。


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).

Short国家的子单位(缩写也可以)Sub-unit of country (abbreviations ok)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesProvince, Territory
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Address.postalCode
Definition

指定一个由邮政服务定义的区域之邮递区号


A postal code designating a region defined by the postal service.

Short邮递区号Postal code for area
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesZip
Example<br/><b>General</b>:9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Address.postalCode.id
Definition

resource中资料项目的唯一ID(用于内部参照)。这可以是任何不含空格的字串。


Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Shortxml:id(或JSON格式)。Unique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
22. Address.postalCode.value
Definition

实际值


The actual value

Short邮递区号Primitive value for string
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Max Length:1048576
24. Address.country
Definition

国家—通常被理解为或普遍被接受的一个国家。


Country - a nation as commonly understood or generally accepted.

Short国家(例如:ISO 3166的2个或3个字母代码)。Country (e.g. can be ISO 3166 2 or 3 letter code)
Comments

可用ISO 3166的3个字母代码来代替人类可读的国家名


ISO 3166 3 letter codes can be used in place of a human readable country name.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Address.period
Definition

此地址曾经/正在使用的时间区间


Time period when address was/is in use.

Short此地址曾经/正在使用的时间区间Time period when address was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Requirements

允许将地址依时间排放


Allows addresses to be placed in historical context.

Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. Address
Definition

使用邮政规范表达的地址(相对于GPS或其他位置定义格式)。这种data type可用于传达投递邮件的位址,以及用于访问可能对邮件投递无效的位置,这世界定义了各种邮政地址格式。

Short使用邮政规范表达的地址(相对于GPS或其他位置定义格式)
Comments

注意:地址的目的是描述用于管理目的之邮政地址,而不是描述绝对的地理座标。邮政地址经常被用作实体位置的代表(亦可见Locationresource)。

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Address.id
Definition

resource中资料项目的唯一ID(用于内部参照)。这可以是任何不含空格的字串。

Short唯一可识别ID,以供资料项目间相互参照。
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Address.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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Address.use
    Definition

    此地址的用途

    Shorthome | work | temp | old | billing - 此地址的用途
    Comments

    应用程序可假定一个地址是目前使用中,除非它明确说它是暂时的或旧的。

    Control0..1
    BindingThe codes SHALL be taken from AddressUse
    (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

    应填入AddressUse值集中的其中一个代码

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    允许从清单中挑选适当的地址用途

    Example<br/><b>General</b>:home
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. Address.type
    Definition

    区分实际地址(你可以拜访的地址)和邮寄地址(如邮政信箱和转递地址),大多数地址都是这两种。

    Shortpostal | physical | both
    Comments

    地址的定义指出「地址旨在描述邮政地址,而不是实体位置」。但许多应用程序追踪一个地址是否具有双重目的,既是一个可以拜访的地点,亦是一个有效的投递目的地,邮政地址经常被用作实体位置的代表(亦可见Locationresource)。

    Control0..1
    BindingThe codes SHALL be taken from AddressType
    (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

    应填入AddressType值集中的其中一个代码

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Example<br/><b>General</b>:both
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Address.text
    Definition

    具体说明整个地址,因为它应该显示在邮政标签上,这可替代或与特定的部分一起提供。

    Short地址的文字表述
    Comments

    可以同时提供文字表述和各部分的地址资料项目内容。更新地址的应用程序 必须(SHALL) 确保当文字表述和各部分的地址资料项目内容都存在时,文字表述不包括各部分的地址资料项目内容中没有的内容,意即两者内容会一致。

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    一个可呈现的、未编码的形式。

    Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Address.line
    Definition

    此部分包含门牌号码、公寓号码、街道名称、街道方向、邮政信箱号码、送货提示以及类似的地址信息。

    Short路/街
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Alternate Names路, 街
    Example<br/><b>General</b>:137 Nowhere Street
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Address.city
    Definition

    市、乡、镇、村或其他社区或配送中心的名称。

    Short乡/镇/市/区
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Alternate NamesMunicpality, 乡, 镇, 市, 区
    Example<br/><b>General</b>:Erewhon
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Address.district
    Definition

    行政区域(县)的名称

    Short县/市
    Comments

    区(district)有时被称为县(country),但在一些区域(regions),「县(country)」被用来代替市(直辖市),所以县名应该用市名来代替传达。

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Alternate NamesCounty, 市
    Example<br/><b>General</b>:Madison
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Address.state
    Definition

    一个国家的子单位,在联邦组织的国家中拥有有限的主权。如果代码被普遍使用,可使用代码(例如:美国2个字母的州代码)。

    Short国家的子单位(缩写也可以)
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Alternate NamesProvince, Territory
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Address.postalCode
    Definition

    指定一个由邮政服务定义的区域之邮递区号

    Short邮递区号
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Alternate NamesZip
    Example<br/><b>General</b>:9132
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Address.postalCode.id
    Definition

    resource中资料项目的唯一ID(用于内部参照)。这可以是任何不含空格的字串。

    Shortxml:id(或JSON格式)。
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    24. Address.postalCode.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource. 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.

    ShortAdditional 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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    26. Address.postalCode.value
    Definition

    实际值

    Short邮递区号
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Max Length:1048576
    28. Address.country
    Definition

    国家—通常被理解为或普遍被接受的一个国家。

    Short国家(例如:ISO 3166的2个或3个字母代码)。
    Comments

    可用ISO 3166的3个字母代码来代替人类可读的国家名

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Address.period
    Definition

    此地址曾经/正在使用的时间区间

    Short此地址曾经/正在使用的时间区间
    Control0..1
    TypePeriod
    Is Modifierfalse
    Summarytrue
    Requirements

    允许将地址依时间排放

    Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))