Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU see ballot notes ). 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 : 1 Informative Use Context : Any

URL for this extension: http://hl7.org/fhir/StructureDefinition/patient-citizenship Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Version: 5.0.0-ballot
Name: citizenship
Title: citizenship
Modifier: This extension is not a modifier extension
Status: draft
Definition: The patient's legal status as citizen of a country.
Committee: Patient Administration Work Group

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

Name Flags Card. Type Description & Constraints doco
. . 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. citizenship

. . . period 0..1 Period Period when Time period of citizenship was effective.


doco Documentation for this format

Full Structure

valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical (Any) 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 valueCodeableReference CodeableReference valueCoding Coding valueContactPoint ContactPoint valueCount Count valueDistance Distance valueDuration Duration valueHumanName HumanName valueIdentifier Identifier valueMoney Money valuePeriod Period valueQuantity Quantity valueRange Range valueRatio Ratio valueRatioRange RatioRange valueReference Reference (Any) valueSampledData SampledData valueSignature Signature valueTiming Timing valueContactDetail ContactDetail valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage
Name Flags Card. Type Description & Constraints doco
. . 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
. . . 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
. . . 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"> I 0..1 Extension  <!-- I 0..1 Nation code of citizenship -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept 

      Value of extension --></valueCodeableConcept>
 </extension>
 <
  <</valuePeriod>

 <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 

{ // citizenship
    "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 Flags Card. Type Description & Constraints doco
. . 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. citizenship

. . . period 0..1 Period Period when Time period of citizenship was effective.


doco Documentation for this format

Full Structure

valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical (Any) 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 valueCodeableReference CodeableReference valueCoding Coding valueContactPoint ContactPoint valueCount Count valueDistance Distance valueDuration Duration valueHumanName HumanName valueIdentifier Identifier valueMoney Money valuePeriod Period valueQuantity Quantity valueRange Range valueRatio Ratio valueRatioRange RatioRange valueReference Reference (Any) valueSampledData SampledData valueSignature Signature valueTiming Timing valueContactDetail ContactDetail valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage
Name Flags Card. Type Description & Constraints doco
. . 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
. . . 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
. . . 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"> I 0..1 Extension  <!-- I 0..1 Nation code of citizenship -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept 

      Value of extension --></valueCodeableConcept>
 </extension>
 <
  <</valuePeriod>

 <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 

{ // citizenship
    "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 unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters @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 )

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.