This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). 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
Patient Administration Work Group | Maturity Level: 1 | Informative | Use 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 ID Patient
usage info: insert a list of places where this extension is used
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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
extension | 0..1 | Extension | Nation code of citizenship | |
extension | 0..0 | |||
url | 1..1 | uri | "code" | |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
extension | 0..1 | Extension | Time period of citizenship | |
extension | 0..0 | |||
url | 1..1 | uri | "period" | |
valuePeriod | 0..1 | Period | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |
value[x] | 0..0 | |||
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><!-- 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 order, Open { // Nation code of citizenship // // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "code", // R! "valueCodeableConcept" : { CodeableConcept } //Value of extension }, { // Time period of citizenship // // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "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 49: }
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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
extension | 0..1 | Extension | Nation code of citizenship | |
extension | 0..0 | |||
url | 1..1 | uri | "code" | |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
extension | 0..1 | Extension | Time period of citizenship | |
extension | 0..0 | |||
url | 1..1 | uri | "period" | |
valuePeriod | 0..1 | Period | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |
value[x] | 0..0 | |||
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><!-- 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 order, Open { // Nation code of citizenship // // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "code", // R! "valueCodeableConcept" : { CodeableConcept } //Value of extension }, { // Time period of citizenship // // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "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 49: }
Constraints