STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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

(No assigned work group)   Maturity Level : 0 Context: Any

URL for this extension: 


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

Status: draft. Extension maintained by: HL7

The nationality of the subject.

Context of Use: Use on element: Patient

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-nationality
Nationality: The nationality of the subject.
Use on element: Patient
. . . code 0..1 CodeableConcept Code representing nationality of patient.
. . . period 0..1 Period Period when nationality was effective.

doco Documentation for this format

Fulle Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-nationality
Nationality: The nationality of the subject.
Use on element: Patient
. . . extension 0..1 Extension Nationality Code
. . . . extension 0 .. 0
. . . . url 1..1 uri "code"
. . . . valueCodeableConcept 1..1 CodeableConcept Value of extension
. . . extension 0..1 Extension Nationality Period
. . . . extension 0 .. 0
. . . . url 1..1 uri "period"
. . . . valuePeriod 1..1 Period Value of extension
. . . url 1..1 uri "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 url  in the specified orderOpen-->
 <extension url="code"> 0..1 Extension  <!-- 0..1 Nationality Code -->
  <valueCodeableConcept><!-- 1..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="period"> 0..1 Extension  <!-- 0..1 Nationality Period -->
  <valuePeriod><!-- 1..1 Period 
      Value of extension --></valuePeriod>
 </extension>
</extension>

JSON Template 

{ // Nationality
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Nationality Code //
        // from Element: extension
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } // R! Value of extension
      },
      { // Nationality Period //
        // from Element: extension
        "url" : "period", // R! 
        "valuePeriod" : { Period } // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-nationality", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-nationality
Nationality: The nationality of the subject.
Use on element: Patient
. . . code 0..1 CodeableConcept Code representing nationality of patient.
. . . period 0..1 Period Period when nationality was effective.

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-nationality
Nationality: The nationality of the subject.
Use on element: Patient
. . . extension 0..1 Extension Nationality Code
. . . . extension 0 .. 0
. . . . url 1..1 uri "code"
. . . . valueCodeableConcept 1..1 CodeableConcept Value of extension
. . . extension 0..1 Extension Nationality Period
. . . . extension 0 .. 0
. . . . url 1..1 uri "period"
. . . . valuePeriod 1..1 Period Value of extension
. . . url 1..1 uri "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 url  in the specified orderOpen-->
 <extension url="code"> 0..1 Extension  <!-- 0..1 Nationality Code -->
  <valueCodeableConcept><!-- 1..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="period"> 0..1 Extension  <!-- 0..1 Nationality Period -->
  <valuePeriod><!-- 1..1 Period 
      Value of extension --></valuePeriod>
 </extension>
</extension>

JSON Template 

{ // Nationality
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Nationality Code //
        // from Element: extension
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } // R! Value of extension
      },
      { // Nationality Period //
        // from Element: extension
        "url" : "period", // R! 
        "valuePeriod" : { Period } // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-nationality", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

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