FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Official Address

Official URL: http://hl7.org/fhir/StructureDefinition/address-official Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: OfficialAddress
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1657

Indicate that this address is meant to be the ‘official’ address for that person. What an ‘official’ address is depends on the country. This extension allows to specify if this address is or it is not the official address, or to indicate that this is the official address for that country.

Context of Use

This extension may be used on the following element(s):

  • Element ID Address

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • New Content

    • Formal Views of Extension Content

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

    This structure is derived from Extension

    Summary

    Simple Extension of type boolean, CodeableConcept: Indicate that this address is meant to be the 'official' address for that person. What an 'official' address is depends on the country. This extension allows to specify if this address is or it is not the official address, or to indicate that this is the official address for that country.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Official Address
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/address-official"
    ... Slices for valueBoolean Content/Rules for all slices
    .... valueBoolean:valueBoolean 0..1 boolean Official address true/false
    ... Slices for valueCodeableConcept Content/Rules for all slices
    .... valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept Official address for country X
    Binding: Jurisdiction ValueSet (required)

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Official Address
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/address-official"
    .... valueBoolean boolean
    .... valueCodeableConcept CodeableConcept
    .... value[x]:valueBoolean 0..1 boolean Official address true/false
    .... value[x]:valueCodeableConcept 0..1 CodeableConcept Official address for country X
    Binding: Jurisdiction ValueSet (required)

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type boolean, CodeableConcept: Indicate that this address is meant to be the 'official' address for that person. What an 'official' address is depends on the country. This extension allows to specify if this address is or it is not the official address, or to indicate that this is the official address for that country.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Official Address
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/address-official"
    ... Slices for valueBoolean Content/Rules for all slices
    .... valueBoolean:valueBoolean 0..1 boolean Official address true/false
    ... Slices for valueCodeableConcept Content/Rules for all slices
    .... valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept Official address for country X
    Binding: Jurisdiction ValueSet (required)

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Official Address
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/address-official"
    .... valueBoolean boolean
    .... valueCodeableConcept CodeableConcept
    .... value[x]:valueBoolean 0..1 boolean Official address true/false
    .... value[x]:valueCodeableConcept 0..1 CodeableConcept Official address for country X
    Binding: Jurisdiction ValueSet (required)

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.value[x]:valueCodeableConceptrequiredJurisdictionValueSet
    http://terminology.hl7.org/ValueSet/jurisdiction

    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()

    Search Parameters for this Extension

    (none found)