FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2

Extension: citizenship

Patient Administration Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/patient-citizenship

Status: draft. Extension maintained by: HL7

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

Context of Use: Use on element: Patient

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-citizenship
citizenship: The patient's legal status as citizen of a country.
Use on element: Patient
... code0..1CodeableConceptNation code representing the citizenship of patient.
... period0..1PeriodPeriod when citizenship was effective.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-citizenship
citizenship: The patient's legal status as citizen of a country.
Use on element: Patient
... extension 0..1ExtensionNation code of citizenship
.... url 1..1uri"code"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
... extension 0..1ExtensionTime period of citizenship
.... url 1..1uri"period"
.... valuePeriod 0..1PeriodValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-citizenship"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- citizenship -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-citizenship" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="code"> 0..1 Extension  <!-- 0..1 Nation code of citizenship -->
  <valueCodeableConcept><!-- 0..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="period"> 0..1 Extension  <!-- 0..1 Time period of citizenship -->
  <valuePeriod><!-- 0..1 Period 
      Value of extension --></valuePeriod>
 </extension>
</extension>

JSON Template

{ // citizenship
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // Nation code of citizenship //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Time period of citizenship //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "period", // R! 
        "valuePeriod" : { Period } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-citizenship", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-citizenship
citizenship: The patient's legal status as citizen of a country.
Use on element: Patient
... code0..1CodeableConceptNation code representing the citizenship of patient.
... period0..1PeriodPeriod when citizenship was effective.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-citizenship
citizenship: The patient's legal status as citizen of a country.
Use on element: Patient
... extension 0..1ExtensionNation code of citizenship
.... url 1..1uri"code"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
... extension 0..1ExtensionTime period of citizenship
.... url 1..1uri"period"
.... valuePeriod 0..1PeriodValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-citizenship"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- citizenship -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-citizenship" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="code"> 0..1 Extension  <!-- 0..1 Nation code of citizenship -->
  <valueCodeableConcept><!-- 0..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="period"> 0..1 Extension  <!-- 0..1 Time period of citizenship -->
  <valuePeriod><!-- 0..1 Period 
      Value of extension --></valuePeriod>
 </extension>
</extension>

JSON Template

{ // citizenship
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // Nation code of citizenship //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Time period of citizenship //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "period", // R! 
        "valuePeriod" : { Period } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-citizenship", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))