Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - 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: nationality

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

Summary

Defining URL:http://hl7.org/fhir/StructureDefinition/patient-nationality
Version:5.0.0-ballot
Name:nationality
Title:nationality
Modifier:This extension is not a modifier extension
Status:draft
Definition:The nationality of the patient.
Committee:Patient Administration Work Group

Status: draft. Extension maintained by: HL7

The nationality of the patient.

Context of Use: Use on Element ID Patient

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..1CodeableConceptNationality Code

... period0..1PeriodNationality Period


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
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:code 0..1ExtensionNationality Code
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"code"
.... value[x] 1..1CodeableConceptValue of extension
... extension:period 0..1ExtensionNationality Period
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"period"
.... value[x] 1..1PeriodValue of extension
... 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"> I 0..1 Extension  <!-- I 0..1 Nationality Code -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="period"> I 0..1 Extension  <!-- I 0..1 Nationality Period -->
  <valuePeriod><!-- I 1..1 Period Value of extension --></valuePeriod>
 </extension>
</extension>

JSON Template

{ // nationality
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Nationality Code // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
      },
      { // Nationality Period // 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 }, // INationality Code
    "extension" : { Extension }, // INationality Period
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-nationality" // R! 
  // value[x]: Value of extension: Prohibited
  }

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..1CodeableConceptNationality Code

... period0..1PeriodNationality Period


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
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:code 0..1ExtensionNationality Code
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"code"
.... value[x] 1..1CodeableConceptValue of extension
... extension:period 0..1ExtensionNationality Period
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"period"
.... value[x] 1..1PeriodValue of extension
... 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"> I 0..1 Extension  <!-- I 0..1 Nationality Code -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="period"> I 0..1 Extension  <!-- I 0..1 Nationality Period -->
  <valuePeriod><!-- I 1..1 Period Value of extension --></valuePeriod>
 </extension>
</extension>

JSON Template

{ // nationality
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Nationality Code // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
      },
      { // Nationality Period // 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 }, // INationality Code
    "extension" : { Extension }, // INationality Period
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-nationality" // R! 
  // value[x]: Value of extension: Prohibited
  }

 

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