Clinical Document Architecture with Australian Schema
1.0.0 - current
Clinical Document Architecture with Australian Schema - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2024-08-29 |
Definitions for the au-Address logical model.
Guidance on how to interpret the contents of this table can be found here
0. AD | |
Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
Short | Australian adaptation of the HL7 International CDA PostalAddress datatype |
Comments | In an event where the Address of the Subject of Care is 'Unknown' or 'Masked / Not to be disclosed for privacy reason', the following conditions SHOULD be applied. The nullFlavor = 'UNK' SHOULD be permitted if the value of address is not known and the value of 'No Fixed Address Indicator' is false. The nullFlavor = 'MSK' SHOULD be permitted if the value of address is masked and the value of 'No Fixed Address Indicator' is false. The nullFlavor = 'NA' SHOULD be permitted if value of 'No Fixed Address Indicator' is true. (This is the same as the current CDA IG constraint). The value of the data group SHALL be populated in all other circumstances. |
Control | 1..* |
Logical Container | ADHA ClinicalDocument (CDA Class) |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. AD.nullFlavor | |
Definition | A flag to indicate whether or not the participant has no fixed address. |
Comments | If true, nullFlavor=NA. If false omit nullFlavor and fill in address. |
Control | 0..1 |
XML Format | In the XML format, this property is represented as an attribute. |
4. AD.isNotOrdered | |
Definition | A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Is Not Ordered |
6. AD.use | |
Definition | The purpose for which the address is being used by the entity. |
Control | 0..* |
Binding | The codes SHALL be taken from CDAPostalAddressUse (required to http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Use Code |
8. AD.item | |
Definition | A series of items that constitute the address. |
Control | 0..* |
Type | http://hl7.org/fhir/StructureDefinition/Base |
Choice Group | This is a repeating choice group that does not appear directly in the instance |
Invariants | AD-1: Can only have only one of the possible item elements in each choice ((delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1 ) |
10. AD.item.delimiter | |
Definition | Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
12. AD.item.delimiter.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DEL |
14. AD.item.country | |
Definition | The country component of the address. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
16. AD.item.country.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CNT |
18. AD.item.state | |
Definition | The designation applied to an internal, political or geographic division of a country other than Australia that is officially recognised by that country. |
Control | 0..1 |
Binding | The codes SHOULD be taken from https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (preferred to https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
20. AD.item.state.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STA |
22. AD.item.county | |
Definition | A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".) |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
24. AD.item.county.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CPA |
26. AD.item.city | |
Definition | The full name of the general locality contained within the specific address. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
28. AD.item.city.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CTY |
30. AD.item.postalCode | |
Definition | The alphanumeric descriptor for a postal delivery area (as by the postal service of a country other than Australia) aligned with locality, suburb or place for an address. |
Comments | Values in this data element SHOULD comply with descriptions in the Australia Post Postcode File. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
32. AD.item.postalCode.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ZIP |
34. AD.item.streetAddressLine | |
Definition | A composite of address details comprising a low level geographical/physical description of a location that, used in conjunction with the other high level address components, i.e. international state/province, international postcode and country, forms a complete geographic/physical address. A composite of one or more low level standard address components describing a geographical/physical location that, used in conjunction with the other high level address components, e.g. Australian suburb/town/locality name, Australian postcode and Australian State/Territory, forms a complete geographical/physical address. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
36. AD.item.streetAddressLine.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SAL |
38. AD.item.houseNumber | |
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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
40. AD.item.houseNumber.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNR |
42. AD.item.houseNumberNumeric | |
Definition | The numeric portion of a building number |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
44. AD.item.houseNumberNumeric.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNN |
46. AD.item.direction | |
Definition | Direction (e.g., N, S, W, E) |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
48. AD.item.direction.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DIR |
50. AD.item.streetName | |
Definition | The name that identifies a public thoroughfare and differentiates it from others in the same suburb/town/locality. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
52. AD.item.streetName.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STR |
54. AD.item.streetNameBase | |
Definition | The base name of a roadway or artery recognized by a municipality (excluding street type and direction) |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
56. AD.item.streetNameBase.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STB |
58. AD.item.streetNameType | |
Definition | A code that identifies the type of public thoroughfare. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
60. AD.item.streetNameType.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STTYP |
62. AD.item.additionalLocator | |
Definition | The Australian Lot reference allocated to an addressin the absence of street numbering. The full name used to identify the physical building or property as part of its location. Descriptor used to classify the type of floor or level of a multistorey building/complex. Descriptor used to identify the floor or level of a multistorey building/complex. A unique number assigned to a postal delivery point as recorded on the Australia Post Postal Address File. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
64. AD.item.additionalLocator.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ADL |
66. AD.item.unitID | |
Definition | The number or name of a specific unit contained within a building or complex, as assigned by that building or complex. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
68. AD.item.unitID.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | UNID |
70. AD.item.unitType | |
Definition | Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
72. AD.item.unitType.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | UNIT |
74. AD.item.careOf | |
Definition | The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
76. AD.item.careOf.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CAR |
78. AD.item.censusTract | |
Definition | A geographic sub-unit delineated for demographic purposes. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
80. AD.item.censusTract.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CEN |
82. AD.item.deliveryAddressLine | |
Definition | Identification for the channel of postal delivery. Identification number for the channel of postal delivery. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
84. AD.item.deliveryAddressLine.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DAL |
86. AD.item.deliveryInstallationType | |
Definition | Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
88. AD.item.deliveryInstallationType.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINST |
90. AD.item.deliveryInstallationArea | |
Definition | The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
92. AD.item.deliveryInstallationArea.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINSTA |
94. AD.item.deliveryInstallationQualifier | |
Definition | A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
96. AD.item.deliveryInstallationQualifier.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINSTQ |
98. AD.item.deliveryMode | |
Definition | Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
100. AD.item.deliveryMode.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DMOD |
102. AD.item.deliveryModeIdentifier | |
Definition | Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number). |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
104. AD.item.deliveryModeIdentifier.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DMODID |
106. AD.item.buildingNumberSuffix | |
Definition | Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
108. AD.item.buildingNumberSuffix.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNS |
110. AD.item.postBox | |
Definition | A numbered box located in a post station. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
112. AD.item.postBox.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | POB |
114. AD.item.precinct | |
Definition | A subsection of a municipality |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
116. AD.item.precinct.partType | |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | PRE |
118. AD.item.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
120. AD.useablePeriod | |
Definition | A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year. |
Control | 0..* |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Useable Period |
Guidance on how to interpret the contents of this table can be found here
0. AD | |
Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. Base definition for all types defined in FHIR type system. |
Short | Australian adaptation of the HL7 International CDA PostalAddress datatypeBase for all types and resources |
Comments | In an event where the Address of the Subject of Care is 'Unknown' or 'Masked / Not to be disclosed for privacy reason', the following conditions SHOULD be applied. The nullFlavor = 'UNK' SHOULD be permitted if the value of address is not known and the value of 'No Fixed Address Indicator' is false. The nullFlavor = 'MSK' SHOULD be permitted if the value of address is masked and the value of 'No Fixed Address Indicator' is false. The nullFlavor = 'NA' SHOULD be permitted if value of 'No Fixed Address Indicator' is true. (This is the same as the current CDA IG constraint). The value of the data group SHALL be populated in all other circumstances. |
Control | 10..* |
Is Modifier | false |
Logical Container | ADHA ClinicalDocument (CDA Class) |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. AD.nullFlavor | |
Definition | A flag to indicate whether or not the participant has no fixed address. |
Comments | If true, nullFlavor=NA. If false omit nullFlavor and fill in address. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
4. AD.isNotOrdered | |
Definition | A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Is Not Ordered |
6. AD.use | |
Definition | The purpose for which the address is being used by the entity. |
Control | 0..* |
Binding | The codes SHALL be taken from CDAPostalAddressUse (required to http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Use Code |
8. AD.item | |
Definition | A series of items that constitute the address. |
Control | 0..* |
Type | http://hl7.org/fhir/StructureDefinition/Base |
Choice Group | This is a repeating choice group that does not appear directly in the instance |
Invariants | AD-1: Can only have only one of the possible item elements in each choice ((delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1 ) |
10. AD.item.delimiter | |
Definition | Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
12. AD.item.delimiter.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DEL |
14. AD.item.country | |
Definition | The country component of the address. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
16. AD.item.country.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CNT |
18. AD.item.state | |
Definition | The designation applied to an internal, political or geographic division of a country other than Australia that is officially recognised by that country. |
Control | 0..1 |
Binding | The codes SHOULD be taken from https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (preferred to https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
20. AD.item.state.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STA |
22. AD.item.county | |
Definition | A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".) |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
24. AD.item.county.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CPA |
26. AD.item.city | |
Definition | The full name of the general locality contained within the specific address. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
28. AD.item.city.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CTY |
30. AD.item.postalCode | |
Definition | The alphanumeric descriptor for a postal delivery area (as by the postal service of a country other than Australia) aligned with locality, suburb or place for an address. |
Comments | Values in this data element SHOULD comply with descriptions in the Australia Post Postcode File. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
32. AD.item.postalCode.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ZIP |
34. AD.item.streetAddressLine | |
Definition | A composite of address details comprising a low level geographical/physical description of a location that, used in conjunction with the other high level address components, i.e. international state/province, international postcode and country, forms a complete geographic/physical address. A composite of one or more low level standard address components describing a geographical/physical location that, used in conjunction with the other high level address components, e.g. Australian suburb/town/locality name, Australian postcode and Australian State/Territory, forms a complete geographical/physical address. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
36. AD.item.streetAddressLine.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SAL |
38. AD.item.houseNumber | |
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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
40. AD.item.houseNumber.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNR |
42. AD.item.houseNumberNumeric | |
Definition | The numeric portion of a building number |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
44. AD.item.houseNumberNumeric.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNN |
46. AD.item.direction | |
Definition | Direction (e.g., N, S, W, E) |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
48. AD.item.direction.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DIR |
50. AD.item.streetName | |
Definition | The name that identifies a public thoroughfare and differentiates it from others in the same suburb/town/locality. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
52. AD.item.streetName.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STR |
54. AD.item.streetNameBase | |
Definition | The base name of a roadway or artery recognized by a municipality (excluding street type and direction) |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
56. AD.item.streetNameBase.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STB |
58. AD.item.streetNameType | |
Definition | A code that identifies the type of public thoroughfare. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
60. AD.item.streetNameType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STTYP |
62. AD.item.additionalLocator | |
Definition | The Australian Lot reference allocated to an addressin the absence of street numbering. The full name used to identify the physical building or property as part of its location. Descriptor used to classify the type of floor or level of a multistorey building/complex. Descriptor used to identify the floor or level of a multistorey building/complex. A unique number assigned to a postal delivery point as recorded on the Australia Post Postal Address File. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
64. AD.item.additionalLocator.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ADL |
66. AD.item.unitID | |
Definition | The number or name of a specific unit contained within a building or complex, as assigned by that building or complex. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
68. AD.item.unitID.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | UNID |
70. AD.item.unitType | |
Definition | Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
72. AD.item.unitType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | UNIT |
74. AD.item.careOf | |
Definition | The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
76. AD.item.careOf.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CAR |
78. AD.item.censusTract | |
Definition | A geographic sub-unit delineated for demographic purposes. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
80. AD.item.censusTract.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CEN |
82. AD.item.deliveryAddressLine | |
Definition | Identification for the channel of postal delivery. Identification number for the channel of postal delivery. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
84. AD.item.deliveryAddressLine.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DAL |
86. AD.item.deliveryInstallationType | |
Definition | Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
88. AD.item.deliveryInstallationType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINST |
90. AD.item.deliveryInstallationArea | |
Definition | The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
92. AD.item.deliveryInstallationArea.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINSTA |
94. AD.item.deliveryInstallationQualifier | |
Definition | A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
96. AD.item.deliveryInstallationQualifier.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINSTQ |
98. AD.item.deliveryMode | |
Definition | Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
100. AD.item.deliveryMode.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DMOD |
102. AD.item.deliveryModeIdentifier | |
Definition | Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number). |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
104. AD.item.deliveryModeIdentifier.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DMODID |
106. AD.item.buildingNumberSuffix | |
Definition | Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
108. AD.item.buildingNumberSuffix.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNS |
110. AD.item.postBox | |
Definition | A numbered box located in a post station. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
112. AD.item.postBox.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | POB |
114. AD.item.precinct | |
Definition | A subsection of a municipality |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
116. AD.item.precinct.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | PRE |
118. AD.item.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
120. AD.useablePeriod | |
Definition | A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year. |
Control | 0..* |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Useable Period |
Guidance on how to interpret the contents of this table can be found here
0. AD | |
Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
Short | Australian adaptation of the HL7 International CDA PostalAddress datatype |
Comments | In an event where the Address of the Subject of Care is 'Unknown' or 'Masked / Not to be disclosed for privacy reason', the following conditions SHOULD be applied. The nullFlavor = 'UNK' SHOULD be permitted if the value of address is not known and the value of 'No Fixed Address Indicator' is false. The nullFlavor = 'MSK' SHOULD be permitted if the value of address is masked and the value of 'No Fixed Address Indicator' is false. The nullFlavor = 'NA' SHOULD be permitted if value of 'No Fixed Address Indicator' is true. (This is the same as the current CDA IG constraint). The value of the data group SHALL be populated in all other circumstances. |
Control | 1..* |
Is Modifier | false |
Logical Container | ADHA ClinicalDocument (CDA Class) |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. AD.nullFlavor | |
Definition | A flag to indicate whether or not the participant has no fixed address. |
Comments | If true, nullFlavor=NA. If false omit nullFlavor and fill in address. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
4. AD.isNotOrdered | |
Definition | A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Is Not Ordered |
6. AD.use | |
Definition | The purpose for which the address is being used by the entity. |
Control | 0..* |
Binding | The codes SHALL be taken from CDAPostalAddressUse (required to http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Use Code |
8. AD.item | |
Definition | A series of items that constitute the address. |
Control | 0..* |
Type | http://hl7.org/fhir/StructureDefinition/Base |
Choice Group | This is a repeating choice group that does not appear directly in the instance |
Invariants | AD-1: Can only have only one of the possible item elements in each choice ((delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1 ) |
10. AD.item.delimiter | |
Definition | Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
12. AD.item.delimiter.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
14. AD.item.delimiter.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
16. AD.item.delimiter.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
18. AD.item.delimiter.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
20. AD.item.delimiter.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
22. AD.item.delimiter.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DEL |
24. AD.item.country | |
Definition | The country component of the address. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
26. AD.item.country.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
28. AD.item.country.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
30. AD.item.country.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
32. AD.item.country.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
34. AD.item.country.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
36. AD.item.country.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CNT |
38. AD.item.state | |
Definition | The designation applied to an internal, political or geographic division of a country other than Australia that is officially recognised by that country. |
Control | 0..1 |
Binding | The codes SHOULD be taken from https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (preferred to https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
40. AD.item.state.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
42. AD.item.state.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
44. AD.item.state.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
46. AD.item.state.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
48. AD.item.state.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
50. AD.item.state.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STA |
52. AD.item.county | |
Definition | A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".) |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
54. AD.item.county.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
56. AD.item.county.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
58. AD.item.county.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
60. AD.item.county.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
62. AD.item.county.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
64. AD.item.county.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CPA |
66. AD.item.city | |
Definition | The full name of the general locality contained within the specific address. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
68. AD.item.city.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
70. AD.item.city.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
72. AD.item.city.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
74. AD.item.city.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
76. AD.item.city.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
78. AD.item.city.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CTY |
80. AD.item.postalCode | |
Definition | The alphanumeric descriptor for a postal delivery area (as by the postal service of a country other than Australia) aligned with locality, suburb or place for an address. |
Comments | Values in this data element SHOULD comply with descriptions in the Australia Post Postcode File. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
82. AD.item.postalCode.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
84. AD.item.postalCode.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
86. AD.item.postalCode.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
88. AD.item.postalCode.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
90. AD.item.postalCode.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
92. AD.item.postalCode.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ZIP |
94. AD.item.streetAddressLine | |
Definition | A composite of address details comprising a low level geographical/physical description of a location that, used in conjunction with the other high level address components, i.e. international state/province, international postcode and country, forms a complete geographic/physical address. A composite of one or more low level standard address components describing a geographical/physical location that, used in conjunction with the other high level address components, e.g. Australian suburb/town/locality name, Australian postcode and Australian State/Territory, forms a complete geographical/physical address. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
96. AD.item.streetAddressLine.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
98. AD.item.streetAddressLine.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
100. AD.item.streetAddressLine.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
102. AD.item.streetAddressLine.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
104. AD.item.streetAddressLine.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
106. AD.item.streetAddressLine.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SAL |
108. AD.item.houseNumber | |
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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
110. AD.item.houseNumber.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
112. AD.item.houseNumber.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
114. AD.item.houseNumber.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
116. AD.item.houseNumber.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
118. AD.item.houseNumber.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
120. AD.item.houseNumber.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNR |
122. AD.item.houseNumberNumeric | |
Definition | The numeric portion of a building number |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
124. AD.item.houseNumberNumeric.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
126. AD.item.houseNumberNumeric.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
128. AD.item.houseNumberNumeric.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
130. AD.item.houseNumberNumeric.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
132. AD.item.houseNumberNumeric.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
134. AD.item.houseNumberNumeric.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNN |
136. AD.item.direction | |
Definition | Direction (e.g., N, S, W, E) |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
138. AD.item.direction.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
140. AD.item.direction.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
142. AD.item.direction.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
144. AD.item.direction.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
146. AD.item.direction.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
148. AD.item.direction.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DIR |
150. AD.item.streetName | |
Definition | The name that identifies a public thoroughfare and differentiates it from others in the same suburb/town/locality. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
152. AD.item.streetName.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
154. AD.item.streetName.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
156. AD.item.streetName.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
158. AD.item.streetName.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
160. AD.item.streetName.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
162. AD.item.streetName.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STR |
164. AD.item.streetNameBase | |
Definition | The base name of a roadway or artery recognized by a municipality (excluding street type and direction) |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
166. AD.item.streetNameBase.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
168. AD.item.streetNameBase.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
170. AD.item.streetNameBase.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
172. AD.item.streetNameBase.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
174. AD.item.streetNameBase.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
176. AD.item.streetNameBase.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STB |
178. AD.item.streetNameType | |
Definition | A code that identifies the type of public thoroughfare. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
180. AD.item.streetNameType.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
182. AD.item.streetNameType.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
184. AD.item.streetNameType.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
186. AD.item.streetNameType.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
188. AD.item.streetNameType.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
190. AD.item.streetNameType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | STTYP |
192. AD.item.additionalLocator | |
Definition | The Australian Lot reference allocated to an addressin the absence of street numbering. The full name used to identify the physical building or property as part of its location. Descriptor used to classify the type of floor or level of a multistorey building/complex. Descriptor used to identify the floor or level of a multistorey building/complex. A unique number assigned to a postal delivery point as recorded on the Australia Post Postal Address File. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
194. AD.item.additionalLocator.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
196. AD.item.additionalLocator.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
198. AD.item.additionalLocator.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
200. AD.item.additionalLocator.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
202. AD.item.additionalLocator.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
204. AD.item.additionalLocator.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | ADL |
206. AD.item.unitID | |
Definition | The number or name of a specific unit contained within a building or complex, as assigned by that building or complex. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
208. AD.item.unitID.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
210. AD.item.unitID.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
212. AD.item.unitID.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
214. AD.item.unitID.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
216. AD.item.unitID.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
218. AD.item.unitID.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | UNID |
220. AD.item.unitType | |
Definition | Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
222. AD.item.unitType.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
224. AD.item.unitType.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
226. AD.item.unitType.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
228. AD.item.unitType.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
230. AD.item.unitType.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
232. AD.item.unitType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | UNIT |
234. AD.item.careOf | |
Definition | The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
236. AD.item.careOf.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
238. AD.item.careOf.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
240. AD.item.careOf.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
242. AD.item.careOf.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
244. AD.item.careOf.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
246. AD.item.careOf.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CAR |
248. AD.item.censusTract | |
Definition | A geographic sub-unit delineated for demographic purposes. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
250. AD.item.censusTract.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
252. AD.item.censusTract.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
254. AD.item.censusTract.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
256. AD.item.censusTract.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
258. AD.item.censusTract.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
260. AD.item.censusTract.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CEN |
262. AD.item.deliveryAddressLine | |
Definition | Identification for the channel of postal delivery. Identification number for the channel of postal delivery. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
264. AD.item.deliveryAddressLine.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
266. AD.item.deliveryAddressLine.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
268. AD.item.deliveryAddressLine.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
270. AD.item.deliveryAddressLine.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
272. AD.item.deliveryAddressLine.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
274. AD.item.deliveryAddressLine.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DAL |
276. AD.item.deliveryInstallationType | |
Definition | Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
278. AD.item.deliveryInstallationType.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
280. AD.item.deliveryInstallationType.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
282. AD.item.deliveryInstallationType.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
284. AD.item.deliveryInstallationType.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
286. AD.item.deliveryInstallationType.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
288. AD.item.deliveryInstallationType.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINST |
290. AD.item.deliveryInstallationArea | |
Definition | The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
292. AD.item.deliveryInstallationArea.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
294. AD.item.deliveryInstallationArea.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
296. AD.item.deliveryInstallationArea.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
298. AD.item.deliveryInstallationArea.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
300. AD.item.deliveryInstallationArea.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
302. AD.item.deliveryInstallationArea.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINSTA |
304. AD.item.deliveryInstallationQualifier | |
Definition | A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
306. AD.item.deliveryInstallationQualifier.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
308. AD.item.deliveryInstallationQualifier.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
310. AD.item.deliveryInstallationQualifier.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
312. AD.item.deliveryInstallationQualifier.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
314. AD.item.deliveryInstallationQualifier.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
316. AD.item.deliveryInstallationQualifier.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DINSTQ |
318. AD.item.deliveryMode | |
Definition | Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
320. AD.item.deliveryMode.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
322. AD.item.deliveryMode.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
324. AD.item.deliveryMode.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
326. AD.item.deliveryMode.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
328. AD.item.deliveryMode.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
330. AD.item.deliveryMode.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DMOD |
332. AD.item.deliveryModeIdentifier | |
Definition | Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number). |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
334. AD.item.deliveryModeIdentifier.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
336. AD.item.deliveryModeIdentifier.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
338. AD.item.deliveryModeIdentifier.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
340. AD.item.deliveryModeIdentifier.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
342. AD.item.deliveryModeIdentifier.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
344. AD.item.deliveryModeIdentifier.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DMODID |
346. AD.item.buildingNumberSuffix | |
Definition | Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
348. AD.item.buildingNumberSuffix.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
350. AD.item.buildingNumberSuffix.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
352. AD.item.buildingNumberSuffix.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
354. AD.item.buildingNumberSuffix.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
356. AD.item.buildingNumberSuffix.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
358. AD.item.buildingNumberSuffix.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | BNS |
360. AD.item.postBox | |
Definition | A numbered box located in a post station. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
362. AD.item.postBox.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
364. AD.item.postBox.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
366. AD.item.postBox.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
368. AD.item.postBox.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
370. AD.item.postBox.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
372. AD.item.postBox.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | POB |
374. AD.item.precinct | |
Definition | A subsection of a municipality |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP |
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1 ) |
376. AD.item.precinct.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
378. AD.item.precinct.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
380. AD.item.precinct.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
Fixed Value | text/plain |
382. AD.item.precinct.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
384. AD.item.precinct.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
386. AD.item.precinct.partType | |
Definition | Specifies the type of the address part |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | PRE |
388. AD.item.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
390. AD.useablePeriod | |
Definition | A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year. |
Control | 0..* |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Useable Period |