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: Patient Citizenship

Official URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship Version: 5.2.0-ballot
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):

  • Element ID Patient

Usage info

Usage:

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

Changes since version 1.0.0:

  • The resource metadata has changed (publisher)
  • The data elements list has changed

    • 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 & Constraintsdoco
    .. Extension 0..* Extension Nation(s) where the patient claims citizenship
    ... Slices for extension Content/Rules for all slices
    .... extension:code 0..1 Extension Nation code of citizenship
    ..... extension 0..0
    ..... url 1..1 uri "code"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: CountryValueSet (preferred)
    .... extension:period 0..1 Extension Time period of citizenship
    ..... extension 0..0
    ..... url 1..1 uri "period"
    ..... value[x] 1..1 Period Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Nation(s) where the patient claims citizenship
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:code 0..1 Extension Nation code of citizenship
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "code"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: CountryValueSet (preferred)
    .... extension:period 0..1 Extension Time period of citizenship
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "period"
    ..... value[x] 1..1 Period Value of 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 & Constraintsdoco
    .. Extension 0..* Extension Nation(s) where the patient claims citizenship
    ... Slices for extension Content/Rules for all slices
    .... extension:code 0..1 Extension Nation code of citizenship
    ..... extension 0..0
    ..... url 1..1 uri "code"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: CountryValueSet (preferred)
    .... extension:period 0..1 Extension Time period of citizenship
    ..... extension 0..0
    ..... url 1..1 uri "period"
    ..... value[x] 1..1 Period Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Nation(s) where the patient claims citizenship
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:code 0..1 Extension Nation code of citizenship
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "code"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: CountryValueSet (preferred)
    .... extension:period 0..1 Extension Time period of citizenship
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "period"
    ..... value[x] 1..1 Period Value of 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

    PathConformanceValueSetURI
    Extension.extension:code.value[x]preferredCountryValueSet
    http://hl7.org/fhir/ValueSet/country
    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()

    Search Parameters for this Extension

    (none found)