R4 Ballot #2 (Mixed Normative/Trial use)

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

Extension: nationality

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

URL for this extension: 

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

Status: draft. Extension maintained by: HL7

The nationality of the patient.

Context of Use: Use on Element ID Patient

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. nationality0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-nationality
nationality: The nationality of the patient.


Use on Element ID Patient
... code0..1CodeableConceptCode representing nationality of patient.

... period0..1PeriodPeriod when nationality was effective.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-nationality
nationality: The nationality of the patient.


Use on Element ID Patient
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension 0..1ExtensionNationality Code
.... extension 0..0
.... url 1..1uri"code"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
... extension 0..1ExtensionNationality Period
.... extension 0..0
.... url 1..1uri"period"
.... valuePeriod 0..1PeriodValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- nationality -->doco

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

JSON Template

{ // nationality
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Nationality Code //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Nationality Period //
        // 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-nationality", // R! 
// value[x]: Value of extension. One of these 49:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. nationality0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-nationality
nationality: The nationality of the patient.


Use on Element ID Patient
... code0..1CodeableConceptCode representing nationality of patient.

... period0..1PeriodPeriod when nationality was effective.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-nationality
nationality: The nationality of the patient.


Use on Element ID Patient
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension 0..1ExtensionNationality Code
.... extension 0..0
.... url 1..1uri"code"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
... extension 0..1ExtensionNationality Period
.... extension 0..0
.... url 1..1uri"period"
.... valuePeriod 0..1PeriodValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- nationality -->doco

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

JSON Template

{ // nationality
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Nationality Code //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Nationality Period //
        // 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-nationality", // R! 
// value[x]: Value of extension. One of these 49:
  }

 

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')]))