Healthcare Financial Services IG Edition 1
0.3.0 - ci-build Saudi Arabia flag

Healthcare Financial Services IG Edition 1 - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: DP_Address

Official URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Address Version: 0.3.0
Draft as of 2025-06-23 Computable Name: DP_Address

Address datatype, only text required, sets lengths for text and key elements.

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 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... use S 0..1 DP_code home | work | temp | old | billing - purpose of this address
... type S 0..1 DP_code postal | physical | both
... text 1..1 string Text representation of the address
Max Length:500
... city S 0..1 string Name of city, town etc.
Max Length:200
... district S 0..1 string District name (aka county)
Max Length:200
... state S 0..1 string Sub-unit of country (abbreviations ok)
Max Length:200
... postalCode S 0..1 string Postal code for area
Max Length:50
... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Max Length:100
... period S 0..1 DP_Period_1 Time period when address was/is in use

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children
... use ?!SΣ 0..1 DP_code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
... type SΣ 0..1 DP_code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


ele-1: All FHIR elements must have a @value or children
Example General: both
... text Σ 1..1 string Text representation of the address
ele-1: All FHIR elements must have a @value or children
Example General: 137 Nowhere Street, Erewhon 9132
Max Length:500
... city SΣ 0..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
Max Length:200
... district SΣ 0..1 string District name (aka county)
ele-1: All FHIR elements must have a @value or children
Example General: Madison
Max Length:200
... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
ele-1: All FHIR elements must have a @value or children
Max Length:200
... postalCode SΣ 0..1 string Postal code for area
ele-1: All FHIR elements must have a @value or children
Example General: 9132
Max Length:50
... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
ele-1: All FHIR elements must have a @value or children
Max Length:100
... period SΣ 0..1 DP_Period_1 Time period when address was/is in use
ele-1: All FHIR elements must have a @value or children
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|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!SΣ 0..1 DP_code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... text Σ 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Max Length:500
... line SΣ 0..* string Street 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
Max Length:200
... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Max Length:200
... district SΣ 0..1 string District name (aka county)
Example General: Madison
Max Length:200
... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Max Length:200
... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
Max Length:50
... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Max Length:100
... period SΣ 0..1 DP_Period_1 Time 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|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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: 1 element
Must-Support: 9 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... use S 0..1 DP_code home | work | temp | old | billing - purpose of this address
... type S 0..1 DP_code postal | physical | both
... text 1..1 string Text representation of the address
Max Length:500
... city S 0..1 string Name of city, town etc.
Max Length:200
... district S 0..1 string District name (aka county)
Max Length:200
... state S 0..1 string Sub-unit of country (abbreviations ok)
Max Length:200
... postalCode S 0..1 string Postal code for area
Max Length:50
... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Max Length:100
... period S 0..1 DP_Period_1 Time period when address was/is in use

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children
... use ?!SΣ 0..1 DP_code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
... type SΣ 0..1 DP_code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


ele-1: All FHIR elements must have a @value or children
Example General: both
... text Σ 1..1 string Text representation of the address
ele-1: All FHIR elements must have a @value or children
Example General: 137 Nowhere Street, Erewhon 9132
Max Length:500
... city SΣ 0..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
Max Length:200
... district SΣ 0..1 string District name (aka county)
ele-1: All FHIR elements must have a @value or children
Example General: Madison
Max Length:200
... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
ele-1: All FHIR elements must have a @value or children
Max Length:200
... postalCode SΣ 0..1 string Postal code for area
ele-1: All FHIR elements must have a @value or children
Example General: 9132
Max Length:50
... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
ele-1: All FHIR elements must have a @value or children
Max Length:100
... period SΣ 0..1 DP_Period_1 Time period when address was/is in use
ele-1: All FHIR elements must have a @value or children
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|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!SΣ 0..1 DP_code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... text Σ 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Max Length:500
... line SΣ 0..* string Street 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
Max Length:200
... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Max Length:200
... district SΣ 0..1 string District name (aka county)
Example General: Madison
Max Length:200
... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Max Length:200
... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
Max Length:50
... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Max Length:100
... period SΣ 0..1 DP_Period_1 Time 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|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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: 1 element
Must-Support: 9 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron