Profile Comparison between http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress vs http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress

Messages

Metadata

Name	Value		Comments
abstract	false
baseDefinition	http://hl7.org/cda/stds/core/StructureDefinition/AD
copyright
date	2024-05-18T00:16:25-05:00	2024-12-19T00:36:20+00:00	Values Differ
description	Reusable address template, for use in US Realm documents. Certifying systems SHALL and non-certifying systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for Street Address Line and City for new and updated records. For certifying systems, this requirement does not apply to historical records/documents that are exposed through C-CDA documents.
experimental
fhirVersion	5.0.0
jurisdiction
jurisdiction[0]	urn:iso:std:iso:3166#US
kind	logical
name	USRealmAddress
publisher	Health Level Seven
purpose
status	draft
title	US Realm Address
type	http://hl7.org/cda/stds/core/StructureDefinition/AD
url	http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress
version	3.0.0	4.0.0-ballot	Values Differ

Structure

Name	L Flags	L Card.	L Type	L Description & Constraints	R Flags	R Card.	R Type	R Description & Constraints	Comments
AD	C	1..*	AD	Base for all types and resources Logical Container: ClinicalDocument (CDA Class) shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country	C	1..*	AD	Base for all types and resources Logical Container: ClinicalDocument (CDA Class) shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
nullFlavor		0..1	??	If addr/@nullFlavor is present, none of the address parts are required. Binding: ?? (required)		0..1	??	If addr/@nullFlavor is present, none of the address parts are required. Binding: ?? (required)
isNotOrdered		0..1	??			0..1	??
use		0..*	??	Identifies which address to use for a given purpose. Binding: ?? (required)		0..*	??	Identifies which address to use for a given purpose. Binding: ?? (required)
item	C	0..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance AD-1: Can only have only one of the possible item elements in each choice	C	0..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance AD-1: Can only have only one of the possible item elements in each choice
delimiter	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: DEL		0..1	??	Fixed Value: DEL
country	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: CNT		0..1	??	Fixed Value: CNT
state	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: STA		0..1	??	Fixed Value: STA
county	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: CPA		0..1	??	Fixed Value: CPA
city	C	0..1	ADXP	city is required if nullFlavor is absent text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	city is required if nullFlavor is absent text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: CTY		0..1	??	Fixed Value: CTY
postalCode	C	0..1	ADXP	If country is US, shall be a 5-digit or 9-digit zip code (##### or #####-####) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	If country is US, shall be a 5-digit or 9-digit zip code (##### or #####-####) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: ZIP		0..1	??	Fixed Value: ZIP
streetAddressLine	C	0..1	ADXP	Min: 1, Max: 4 streetAddressLine required if nullFlavor is absent text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	Min: 1, Max: 4 streetAddressLine required if nullFlavor is absent text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: SAL		0..1	??	Fixed Value: SAL
houseNumber	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: BNR		0..1	??	Fixed Value: BNR
houseNumberNumeric	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: BNN		0..1	??	Fixed Value: BNN
direction	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: DIR		0..1	??	Fixed Value: DIR
streetName	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: STR		0..1	??	Fixed Value: STR
streetNameBase	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: STB		0..1	??	Fixed Value: STB
streetNameType	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: STTYP		0..1	??	Fixed Value: STTYP
additionalLocator	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: ADL		0..1	??	Fixed Value: ADL
unitID	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: UNID		0..1	??	Fixed Value: UNID
unitType	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: UNIT		0..1	??	Fixed Value: UNIT
careOf	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: CAR		0..1	??	Fixed Value: CAR
censusTract	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: CEN		0..1	??	Fixed Value: CEN
deliveryAddressLine	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: DAL		0..1	??	Fixed Value: DAL
deliveryInstallationType	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: DINST		0..1	??	Fixed Value: DINST
deliveryInstallationArea	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: DINSTA		0..1	??	Fixed Value: DINSTA
deliveryInstallationQualifier	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: DINSTQ		0..1	??	Fixed Value: DINSTQ
deliveryMode	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: DMOD		0..1	??	Fixed Value: DMOD
deliveryModeIdentifier	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: DMODID		0..1	??	Fixed Value: DMODID
buildingNumberSuffix	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: BNS		0..1	??	Fixed Value: BNS
postBox	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: POB		0..1	??	Fixed Value: POB
precinct	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)	C	0..1	ADXP	text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
representation		0..1	??	Fixed Value: TXT		0..1	??	Fixed Value: TXT
mediaType		0..1	??	Fixed Value: text/plain		0..1	??	Fixed Value: text/plain
language		0..1	??			0..1	??
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
partType		0..1	??	Fixed Value: PRE		0..1	??	Fixed Value: PRE
xmlText		0..1	??	Allows for mixed text content		0..1	??	Allows for mixed text content
useablePeriod		0..*	IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS	(USCDI) Previous Address - Current or prior place where a person may have been located or could have been contacted.		0..*	IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS	𝗨𝗦𝗖𝗗𝗜: Previous Address - Current or prior place where a person may have been located or could have been contacted.
Documentation for this format