Pharmaceutical Quality Submissions to Food & Drug Administration (PQ/CMC)
0.1.20 - Build CI United States of America flag

Pharmaceutical Quality Submissions to Food & Drug Administration (PQ/CMC), published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.20 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/FHIR-us-pq-cmc/ and changes regularly. See the Directory of published versions

Data Type Profile: PqAddress

Official URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-cmc-address Version: 0.1.20
Draft as of 2024-03-04 Computable Name: PqAddress

pq-specific Constraints on the Address datatype dealing with US addresses.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
addr-state: If the country is USA, then the state and postal code exist
addr-zip: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
... line 1..2stringStreet name, number, direction & P.O. Box etc.
... city S1..1stringName of city, town etc.
... state S0..1stringSub-unit of country (abbreviations ok)
... country S1..1stringCountry can either be the ISO 3-letter country code or the full country name matching the code. The codes and full names are in the value set: GENC 3 Letter Codes

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
addr-stateerrorAddressIf the country is USA, then the state and postal code exist
: country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists())
addr-ziperrorAddressIf the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
: country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
addr-state: If the country is USA, then the state and postal code exist
addr-zip: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
... line Σ1..2stringStreet 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 SΣ1..1stringName of city, town etc.
Example General: Erewhon
... postalCode SΣ1..1stringPostal code for area
Example General: 9132
... country SΣ1..1stringCountry can either be the ISO 3-letter country code or the full country name matching the code. The codes and full names are in the value set: GENC 3 Letter Codes

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
addr-stateerrorAddressIf the country is USA, then the state and postal code exist
: country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists())
addr-ziperrorAddressIf the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
: country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
addr-state: If the country is USA, then the state and postal code exist
addr-zip: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
... id 0..1idUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ1..2stringStreet 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 SΣ1..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state SΣ0..1stringSub-unit of country (abbreviations ok)
... postalCode SΣ1..1stringPostal code for area
Example General: 9132
... country SΣ1..1stringCountry can either be the ISO 3-letter country code or the full country name matching the code. The codes and full names are in the value set: GENC 3 Letter Codes
... 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

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
addr-stateerrorAddressIf the country is USA, then the state and postal code exist
: country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists())
addr-ziperrorAddressIf the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
: country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Address

Summary

Mandatory: 4 elements
Must-Support: 4 elements

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
addr-state: If the country is USA, then the state and postal code exist
addr-zip: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
... line 1..2stringStreet name, number, direction & P.O. Box etc.
... city S1..1stringName of city, town etc.
... state S0..1stringSub-unit of country (abbreviations ok)
... country S1..1stringCountry can either be the ISO 3-letter country code or the full country name matching the code. The codes and full names are in the value set: GENC 3 Letter Codes

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
addr-stateerrorAddressIf the country is USA, then the state and postal code exist
: country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists())
addr-ziperrorAddressIf the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
: country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
addr-state: If the country is USA, then the state and postal code exist
addr-zip: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
... line Σ1..2stringStreet 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 SΣ1..1stringName of city, town etc.
Example General: Erewhon
... postalCode SΣ1..1stringPostal code for area
Example General: 9132
... country SΣ1..1stringCountry can either be the ISO 3-letter country code or the full country name matching the code. The codes and full names are in the value set: GENC 3 Letter Codes

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
addr-stateerrorAddressIf the country is USA, then the state and postal code exist
: country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists())
addr-ziperrorAddressIf the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
: country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
addr-state: If the country is USA, then the state and postal code exist
addr-zip: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
... id 0..1idUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ1..2stringStreet 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 SΣ1..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state SΣ0..1stringSub-unit of country (abbreviations ok)
... postalCode SΣ1..1stringPostal code for area
Example General: 9132
... country SΣ1..1stringCountry can either be the ISO 3-letter country code or the full country name matching the code. The codes and full names are in the value set: GENC 3 Letter Codes
... 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

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
addr-stateerrorAddressIf the country is USA, then the state and postal code exist
: country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists())
addr-ziperrorAddressIf the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
: country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Address

Summary

Mandatory: 4 elements
Must-Support: 4 elements

 

Other representations of profile: CSV, Excel, Schematron