FHIR Extensions Pack
5.3.0 - May 2026 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.3.0 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: Patient Citizenship

Official URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship Version: 5.3.0
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Patient Administration Computable Name: PatCitizenship
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1330

The patient's legal status as citizen of a country.

Context of Use

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

Usage info

Usages:

  • This Extension is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Changes since version 5.3.0:

  • No changes

    • 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

    Complex Extension: The patient's legal status as citizen of a country.

    • code: CodeableConcept: Nation code representing the citizenship of patient.
    • period: Period: Period when citizenship was effective.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..* Extension Nation(s) where the patient claims citizenship
    Extension.Slices for extension Content/Rules for all slices
    Extension.Slices for extension.extension:code 0..1 Extension Nation code of citizenship
    Extension.Slices for extension.extension:code.extension 0..0 Extension
    Extension.Slices for extension.extension:code.url 1..1 uri "code"
    Extension.Slices for extension.extension:code.value[x] 1..1 CodeableConcept Value of extension
    Binding: CountryValueSet (preferred)
    Extension.Slices for extension.extension:period 0..1 Extension Time period of citizenship
    Extension.Slices for extension.extension:period.extension 0..0 Extension
    Extension.Slices for extension.extension:period.url 1..1 uri "period"
    Extension.Slices for extension.extension:period.value[x] 1..1 Period Value of extension
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
    Extension.value[x] 0..0 Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..* Extension Nation(s) where the patient claims citizenship
    Extension.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Extension.Slices for extension.extension:code 0..1 Extension Nation code of citizenship
    Extension.Slices for extension.extension:code.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension.extension:code.extension 0..0 Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:code.url 1..1 uri "code"
    Extension.Slices for extension.extension:code.value[x] 1..1 CodeableConcept Value of extension
    Binding: CountryValueSet (preferred)
    Extension.Slices for extension.extension:period 0..1 Extension Time period of citizenship
    Extension.Slices for extension.extension:period.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension.extension:period.extension 0..0 Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:period.url 1..1 uri "period"
    Extension.Slices for extension.extension:period.value[x] 1..1 Period Value of extension
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-citizenship"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: The patient's legal status as citizen of a country.

    • code: CodeableConcept: Nation code representing the citizenship of patient.
    • period: Period: Period when citizenship was effective.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..* Extension Nation(s) where the patient claims citizenship
    Extension.Slices for extension Content/Rules for all slices
    Extension.Slices for extension.extension:code 0..1 Extension Nation code of citizenship
    Extension.Slices for extension.extension:code.extension 0..0 Extension
    Extension.Slices for extension.extension:code.url 1..1 uri "code"
    Extension.Slices for extension.extension:code.value[x] 1..1 CodeableConcept Value of extension
    Binding: CountryValueSet (preferred)
    Extension.Slices for extension.extension:period 0..1 Extension Time period of citizenship
    Extension.Slices for extension.extension:period.extension 0..0 Extension
    Extension.Slices for extension.extension:period.url 1..1 uri "period"
    Extension.Slices for extension.extension:period.value[x] 1..1 Period Value of extension
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
    Extension.value[x] 0..0 Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..* Extension Nation(s) where the patient claims citizenship
    Extension.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Extension.Slices for extension.extension:code 0..1 Extension Nation code of citizenship
    Extension.Slices for extension.extension:code.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension.extension:code.extension 0..0 Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:code.url 1..1 uri "code"
    Extension.Slices for extension.extension:code.value[x] 1..1 CodeableConcept Value of extension
    Binding: CountryValueSet (preferred)
    Extension.Slices for extension.extension:period 0..1 Extension Time period of citizenship
    Extension.Slices for extension.extension:period.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension.extension:period.extension 0..0 Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:period.url 1..1 uri "period"
    Extension.Slices for extension.extension:period.value[x] 1..1 Period Value of extension
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-citizenship"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Extension.extension:code.​value[x] Base preferred Country ValueSet 📦5.0.0 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    R4B

    The extension is unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is unchanged in R3

    Search Parameters for this Extension

    (none found)