​

SD.1 StructureDefinition-dpc-profile-address

The profile defines the required format for Address datatypes for Organization resources within the DPC application. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Address element must have:

  1. an address use
  2. an address type
  3. an address line
  4. a city
  5. a state
  6. a postal code
  7. a country

If the data is available an Address shall include:

  1. a district

SD.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-address

Published on Wed Apr 21 11:33:40 EDT 2021 as a draft by The DPC Team.

This profile builds on Address

Summary

Mandatory: 7 elements
Prohibited: 1 element

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... use 1..1codehome | work | temp | old - purpose of this address
... type 1..1codepostal | physical | both
... text 0..0
... line 1..*stringStreet name, number, direction & P.O. Box etc.
... city 1..1stringName of city, town etc.
... state 1..1stringSub-unit of country (abbreviations ok)
... postalCode 1..1stringPostal code for area
... country 1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ1..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General: home
... type Σ1..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
... line Σ1..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
... city Σ1..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ1..1stringSub-unit of country (abbreviations ok)
... postalCode Σ1..1stringPostal code for area
Example General: 9132
... country Σ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron