This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). 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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: citizenship

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 ID Patient

Extension Content

• Summary
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
citizenship		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-citizenship citizenship: The patient's legal status as citizen of a country. Use on Element ID Patient
code		0..1	CodeableConcept	Nation code representing the citizenship of patient.
period		0..1	Period	Period when citizenship was effective.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-citizenship citizenship: The patient's legal status as citizen of a country. Use on Element ID Patient
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code	I	0..1	Extension	Nation code of citizenship
extension	I	0..0
url		1..1	uri	"code"
value[x]	I	1..1	CodeableConcept	Value of extension
extension:period	I	0..1	Extension	Time period of citizenship
extension	I	0..0
url		1..1	uri	"period"
value[x]	I	1..1	Period	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-citizenship"
value[x]	I	0..0
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical()
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference()
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
Documentation for this format

XML Template

<!-- citizenship -->

<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><!--  1..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="period">  0..1 Extension  <!--  0..1 Time period of citizenship -->
  <valuePeriod><!--  1..1 Period Value of extension --></valuePeriod>
 </extension>
</extension>

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
citizenship		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-citizenship citizenship: The patient's legal status as citizen of a country. Use on Element ID Patient
code		0..1	CodeableConcept	Nation code representing the citizenship of patient.
period		0..1	Period	Period when citizenship was effective.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-citizenship citizenship: The patient's legal status as citizen of a country. Use on Element ID Patient
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code	I	0..1	Extension	Nation code of citizenship
extension	I	0..0
url		1..1	uri	"code"
value[x]	I	1..1	CodeableConcept	Value of extension
extension:period	I	0..1	Extension	Time period of citizenship
extension	I	0..0
url		1..1	uri	"period"
value[x]	I	1..1	Period	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-citizenship"
value[x]	I	0..0
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical()
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference()
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
Documentation for this format

XML Template

<!-- citizenship -->

<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><!--  1..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="period">  0..1 Extension  <!--  0..1 Time period of citizenship -->
  <valuePeriod><!--  1..1 Period Value of extension --></valuePeriod>
 </extension>
</extension>

JSON Template

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

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