New Zealand NHI IG
1.6.5 - Release

New Zealand NHI IG - Local Development build (v1.6.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: BirthPlace

Official URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place Version: 1.6.5
Active as of 2025-07-31 Computable Name: BirthPlace

The country where the person was born

Context of Use

    This extension may be used on the following element(s)

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:country 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "country"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
.... extension:place-of-birth 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "place-of-birth"
..... value[x] 0..1 string Value of extension
.... extension:source 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "source"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Country of Birth Information Source (required)
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/birth-place"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Extension
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:country 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "country"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
.... extension:place-of-birth 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "place-of-birth"
..... value[x] 0..1 string Value of extension
.... extension:source 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "source"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Country of Birth Information Source (required)
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/birth-place"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The country where the person was born

  • country: CodeableConcept: The birth country.
  • place-of-birth: string: No description
  • source: CodeableConcept: The source of information concerning the country of birth

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:country 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "country"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
.... extension:place-of-birth 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "place-of-birth"
..... value[x] 0..1 string Value of extension
.... extension:source 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "source"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Country of Birth Information Source (required)
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/birth-place"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Extension
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:country 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "country"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
.... extension:place-of-birth 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "place-of-birth"
..... value[x] 0..1 string Value of extension
.... extension:source 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "source"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Country of Birth Information Source (required)
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/birth-place"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The country where the person was born

  • country: CodeableConcept: The birth country.
  • place-of-birth: string: No description
  • source: CodeableConcept: The source of information concerning the country of birth

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:country.value[x]requiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Extension.extension:source.value[x]requiredNhi_country_of_birth_source
https://nzhts.digital.health.nz/fhir/ValueSet/country-of-birth-source-code

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()