BirthPlace
type: StructureDefinition
node role: treeRoot
id:
  v: BirthPlace
text:
  status:
    v: extensions
  div: Generated Narrative: StructureDefinition BirthPlace Name Flags Card. Type Description & Constraints Extension S 0..1 Extension Birth Place extension 0..0 url 1..1 uri "https://ohapi-fhir-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-BirthPlace" value[x] 1..1 Address Value of extension use 0..0 type 0..0 text 0..0 line 0..0 district 0..0 postalCode 0..0 period 0..0 Documentation for this format
url:
  v: https://ohapi-fhir-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-BirthPlace
version:
  v: 0.10.1
name:
  v: BirthPlace
title:
  v: Birth Place
status:
  v: draft
date:
  v: 2025-02-10
publisher:
  v: minsait - An Indra Company
contact:
  name:
    v: Secretaría de Salud de Bogotá
  telecom:
    system:
      v: url
    value:
      v: https://www.saludcapital.gov.co/
description:
  v: Geographical location of birth of the patient.
copyright:
  v: Secretaría de Salud de Bogotá
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: complex-type
abstract:
  v: false
context:
  type:
    v: element
  expression:
    v: Patient
type:
  v: Extension
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Extension
  link: http://hl7.org/fhir/StructureDefinition/Extension
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    value: string
      v: 4.0.1
  element:
    id:
      v: Extension
    path:
      v: Extension
    short:
      v: Birth Place
    definition:
      v: Geographical location of birth of the patient.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Extension
      min:
        v: 0
      max:
        v: *
    condition:
      v: ele-1
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        link: http://hl7.org/fhir/StructureDefinition/Element
    constraint:
      key:
        v: ext-1
      severity:
        v: error
      human:
        v: Must have either extensions or value[x], not both
      expression:
        v: extension.exists() != value.exists()
      xpath:
        v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
      source:
        v: http://hl7.org/fhir/StructureDefinition/Extension
        link: http://hl7.org/fhir/StructureDefinition/Extension
    must support:
      v: true
    is modifier:
      v: false
  element:
    id:
      v: Extension.id
    path:
      v: Extension.id
    representation:
      v: xmlAttr
    short:
      v: Unique id for inter-element referencing
    definition:
      v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Element.id
      min:
        v: 0
      max:
        v: 1
    type:
      extension:
        value: url
      code:
        v: http://hl7.org/fhirpath/System.String
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: Extension.extension
    path:
      v: Extension.extension
    slicing:
      description:
        v: Extensions are always sliced by (at least) url
      rules:
        v: open
    short:
      v: Extension
    definition:
      v: An Extension
    min:
      v: 0
    max:
      v: 0
    base:
      path:
        v: Element.extension
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: Extension
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        link: http://hl7.org/fhir/StructureDefinition/Element
    constraint:
      key:
        v: ext-1
      severity:
        v: error
      human:
        v: Must have either extensions or value[x], not both

url
v: string

v: value

v: url

v: extension.exists() != value.exists()

v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])

v: false

v: false

id:
  v: Extension.url
path:
  v: Extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed: uri
  v: https://ohapi-fhir-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-BirthPlace
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Extension.value[x]
path:
  v: Extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Address
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Extension.value[x].id
path:
  v: Extension.value[x].id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Extension.value[x].extension
path:
  v: Extension.value[x].extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Extension.value[x].use
path:
  v: Extension.value[x].use
short:
  v: home | work | temp | old | billing - purpose of this address
definition:
  v: The purpose of this address.
comment:
  v: Applications can assume that an address is current unless it explicitly says that it is temporary or old.
requirements:
  v: Allows an appropriate address to be chosen from a list of many.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Address.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
example:
  label:
    v: General
  value: code
    v: home
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: AddressUse
  strength:
    v: required
  description:
    v: The use of an address.
  value set:
    v: http://hl7.org/fhir/ValueSet/address-use|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: XAD.7
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./AddressPurpose

id:
  v: Extension.value[x].type
path:
  v: Extension.value[x].type
short:
  v: postal | physical | both
definition:
  v: Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
comment:
  v: The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](http://hl7.org/fhir/R4/location.html#) resource).
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Address.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
example:
  label:
    v: General
  value: code
    v: both
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: AddressType
  strength:
    v: required
  description:
    v: The type of an address (physical / postal).
  value set:
    v: http://hl7.org/fhir/ValueSet/address-type|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: XAD.18
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: vcard
  map:
    v: address type parameter

id:
  v: Extension.value[x].text
path:
  v: Extension.value[x].text
short:
  v: Text representation of the address
definition:
  v: Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
comment:
  v: Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
requirements:
  v: A renderable, unencoded form.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Address.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
example:
  label:
    v: General
  value: string
    v: 137 Nowhere Street, Erewhon 9132
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
mapping:
  identity:
    v: rim
  map:
    v: ./formatted
mapping:
  identity:
    v: vcard
  map:
    v: address label parameter

id:
  v: Extension.value[x].line
path:
  v: Extension.value[x].line
short:
  v: Street name, number, direction & P.O. Box etc.
definition:
  v: This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Address.line
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
order meaning:
  v: The order in which lines should appear in an address label
example:
  label:
    v: General
  value: string
    v: 137 Nowhere Street
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = AL]
mapping:
  identity:
    v: vcard
  map:
    v: street
mapping:
  identity:
    v: servd
  map:
    v: ./StreetAddress (newline delimitted)

id:
  v: Extension.value[x].city
path:
  v: Extension.value[x].city
short:
  v: Name of city, town etc.
definition:
  v: The name of the city, town, suburb, village or other community or delivery center.
alias:
  v: Municpality
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.city
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
example:
  label:
    v: General
  value: string
    v: Erewhon
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.3
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = CTY]
mapping:
  identity:
    v: vcard
  map:
    v: locality
mapping:
  identity:
    v: servd
  map:
    v: ./Jurisdiction

id:
  v: Extension.value[x].district
path:
  v: Extension.value[x].district
short:
  v: District name (aka county)
definition:
  v: The name of the administrative area (county).
comment:
  v: District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
alias:
  v: County
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Address.district
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
example:
  label:
    v: General
  value: string
    v: Madison
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.9
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = CNT | CPA]

id:
  v: Extension.value[x].state
path:
  v: Extension.value[x].state
short:
  v: Sub-unit of country (abbreviations ok)
definition:
  v: Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
alias:
  v: Province
alias:
  v: Territory
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.state
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.4
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = STA]
mapping:
  identity:
    v: vcard
  map:
    v: region
mapping:
  identity:
    v: servd
  map:
    v: ./Region

id:
  v: Extension.value[x].postalCode
path:
  v: Extension.value[x].postalCode
short:
  v: Postal code for area
definition:
  v: A postal code designating a region defined by the postal service.
alias:
  v: Zip
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Address.postalCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
example:
  label:
    v: General
  value: string
    v: 9132
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.5
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = ZIP]
mapping:
  identity:
    v: vcard
  map:
    v: code
mapping:
  identity:
    v: servd
  map:
    v: ./PostalIdentificationCode

id:
  v: Extension.value[x].country
path:
  v: Extension.value[x].country
short:
  v: Country (e.g. can be ISO 3166 2 or 3 letter code)
definition:
  v: Country - a nation as commonly understood or generally accepted.
comment:
  v: ISO 3166 3 letter codes can be used in place of a human readable country name.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.country
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.6
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = CNT]
mapping:
  identity:
    v: vcard
  map:
    v: country
mapping:
  identity:
    v: servd
  map:
    v: ./Country

id:
  v: Extension.value[x].period
path:
  v: Extension.value[x].period
short:
  v: Time period when address was/is in use
definition:
  v: Time period when address was/is in use.
requirements:
  v: Allows addresses to be placed in historical context.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Address.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
example:
  label:
    v: General
  value: Period
    start:
      v: 2010-03-23
    end:
      v: 2010-07-01
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.12 / XAD.13 + XAD.14
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

element:
  id:
    v: Extension
  path:
    v: Extension
  short:
    v: Birth Place
  definition:
    v: Geographical location of birth of the patient.
  max:
    v: 1
  must support:
    v: true
element:
  id:
    v: Extension.extension
  path:
    v: Extension.extension
  max:
    v: 0
element:
  id:
    v: Extension.url
  path:
    v: Extension.url
  fixed: uri
    v: https://ohapi-fhir-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-BirthPlace
element:
  id:
    v: Extension.value[x]
  path:
    v: Extension.value[x]
  min:
    v: 1
  type:
    code:
      v: Address
element:
  id:
    v: Extension.value[x].use
  path:
    v: Extension.value[x].use
  max:
    v: 0
element:
  id:
    v: Extension.value[x].type
  path:
    v: Extension.value[x].type
  max:
    v: 0
element:
  id:
    v: Extension.value[x].text
  path:
    v: Extension.value[x].text
  max:
    v: 0
element:
  id:
    v: Extension.value[x].line
  path:
    v: Extension.value[x].line
  max:
    v: 0
element:
  id:
    v: Extension.value[x].district
  path:
    v: Extension.value[x].district
  max:
    v: 0
element:
  id:
    v: Extension.value[x].postalCode
  path:
    v: Extension.value[x].postalCode
  max:
    v: 0
element:
  id:
    v: Extension.value[x].period
  path:
    v: Extension.value[x].period
  max:
    v: 0