Extension: Patient Citizenship

Patient Administration Work Group

Maturity Level: 1

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/patient-citizenship`				Version: 5.0.0-snapshot3
draft as of 2020-12-28				Computable Name: PatCitizenship
Flags: Non-Modifier				OID: 2.16.840.1.113883.4.642.5.1330

Context of Use: Use on Element ID Patient

Definition

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

Summary

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

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-citizenship PatCitizenship: The patient's legal status as citizen of a country. Use on Element ID Patient
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
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"
value[x]	0..0
Documentation for this format

XML Template

<!-- PatCitizenship -->

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

JSON Template

{ // PatCitizenship
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Nation code of citizenship // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
      },
      { // Time period of citizenship // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "period", // R! 
        "valuePeriod" : { Period } // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // INation code of citizenship
    "extension" : { Extension }, // ITime period of citizenship
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-citizenship" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

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

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-citizenship PatCitizenship: The patient's legal status as citizen of a country. Use on Element ID Patient
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
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"
value[x]	0..0
Documentation for this format

XML Template

<!-- PatCitizenship -->

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

JSON Template

{ // PatCitizenship
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Nation code of citizenship // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
      },
      { // Time period of citizenship // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "period", // R! 
        "valuePeriod" : { Period } // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // INation code of citizenship
    "extension" : { Extension }, // ITime period of citizenship
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-citizenship" // R! 
  // value[x]: Value of extension: Prohibited
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.