Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). 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: 1

Informative

Use 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

Summary

Name	Card.	Type	Description & Constraints
nationality	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-nationality nationality: The nationality of the patient. Use on Element ID Patient
code	0..1	CodeableConcept	Code representing nationality of patient.
period	0..1	Period	Period when nationality was effective.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-nationality nationality: The nationality of the patient. Use on Element ID Patient
extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code	0..1	Extension	Nationality Code
id	0..1	string	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	Nationality Period
id	0..1	string	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-nationality"
value[x]	0..0
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
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
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
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
valueMeta		Meta
Documentation for this format

XML Template

<!-- nationality -->

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

Summary

Name	Card.	Type	Description & Constraints
nationality	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-nationality nationality: The nationality of the patient. Use on Element ID Patient
code	0..1	CodeableConcept	Code representing nationality of patient.
period	0..1	Period	Period when nationality was effective.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-nationality nationality: The nationality of the patient. Use on Element ID Patient
extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code	0..1	Extension	Nationality Code
id	0..1	string	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	Nationality Period
id	0..1	string	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-nationality"
value[x]	0..0
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
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
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
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
valueMeta		Meta
Documentation for this format

XML Template

<!-- nationality -->

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

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)