PID
type: StructureDefinition
node role: treeRoot
id:
  v: PID
meta:
  last updated:
    v: 2023-08-09T18:09:04.256+02:00
text:
  status:
    v: generated
  div: Segment: PID
url:
  v: http://hl7.org/fhir/StructureDefinition/PID
version:
  v: 2.9
name:
  v: PID
title:
  v: PID (Segment)
status:
  v: draft
experimental:
  v: true
date:
  v: 2023-08-09T18:09:04+02:00
publisher:
  v: FO
description:
  v: Patient Identification
copyright:
  v: FO
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: PID
base definition:
  v: http://hl7.org/fhir/StructureDefinition/DomainResource
  link: http://hl7.org/fhir/StructureDefinition/DomainResource
derivation:
  v: specialization
snapshot:
  element:
    id:
      v: PID
    path:
      v: PID
    short:
      v: A resource with narrative, extensions, and contained resources
    definition:
      v: Patient Identification
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: DomainResource
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
      expression:
        v: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-5
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a security label
      expression:
        v: contained.meta.security.empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-6
      severity:
        v: warning
      human:
        v: A resource should have narrative for robust management
      expression:
        v: text.`div`.exists()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    must support:
      v: false
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: Entity. Role, or Act,Entity, Role, or Act
  element:
    id:
      v: PID.id
    path:
      v: PID.id
    short:
      v: Logical id of this artifact
    definition:
      v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
    comment:
      v: Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Resource.id
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: http://hl7.org/fhirpath/System.String
    must support:
      v: false
    is modifier:
      v: false
    is summary:
      v: true
  element:
    id:
      v: PID.meta
    path:
      v: PID.meta
    short:
      v: Metadata about the resource
    definition:
      v: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Resource.meta
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: Meta
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children

v: true

v: When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

v: id

v: hasValue() or (children().count() > id.count())

v: false

v: false

v: true

id:
  v: PID.implicitRules
path:
  v: PID.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
comment:
  v: Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
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())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
is summary:
  v: true

id:
  v: PID.language
path:
  v: PID.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
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())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: Language
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding
    value:
      v: true
  strength:
    v: required
  description:
    v: IETF language tag for a human language
  value set:
    v: http://hl7.org/fhir/ValueSet/all-languages|5.0.0
    link: 5.0
    link: .0
  additional:
    purpose:
      v: starter
    value set:
      v: http://hl7.org/fhir/ValueSet/languages
      link: http://hl7.org/fhir/ValueSet/languages

id:
  v: PID.text
path:
  v: PID.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
comment:
  v: Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
condition:
  v: dom-6
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())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: PID.contained
path:
  v: PID.contained
short:
  v: Contained, inline Resources
definition:
  v: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
comment:
  v: This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
condition:
  v: dom-2
condition:
  v: dom-4
condition:
  v: dom-3
condition:
  v: dom-5
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: PID.extension
path:
  v: PID.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 resource. To make the use of extensions safe and managable, 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: DomainResource.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())
  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()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: PID.modifierExtension
path:
  v: PID.modifierExtension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  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())
  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()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: false
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: PID.setID-PID
path:
  v: PID.setID-PID
short:
  v: setID-PID
definition:
  v: **Set ID - PID**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.setID-PID
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: SI
max length:
  v: 4

id:
  v: PID.patientID
path:
  v: PID.patientID
short:
  v: patientID
definition:
  v: **Patient ID**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.patientID
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: -

id:
  v: PID.patientIdentifierList
path:
  v: PID.patientIdentifierList
short:
  v: patientIdentifierList
definition:
  v: **Patient Identifier List**
min:
  v: 1
max:
  v: *
base:
  path:
    v: PID.patientIdentifierList
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: CX
must support:
  v: true

id:
  v: PID.alternatePatientID-PID
path:
  v: PID.alternatePatientID-PID
short:
  v: alternatePatientID-PID
definition:
  v: **Alternate Patient ID - PID**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.alternatePatientID-PID
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: -

id:
  v: PID.patientName
path:
  v: PID.patientName
short:
  v: patientName
definition:
  v: **Patient Name**
min:
  v: 1
max:
  v: *
base:
  path:
    v: PID.patientName
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: XPN
must support:
  v: true

id:
  v: PID.mothersMaidenName
path:
  v: PID.mothersMaidenName
short:
  v: mothersMaidenName
definition:
  v: **Mother's Maiden Name**
min:
  v: 0
max:
  v: *
base:
  path:
    v: PID.mothersMaidenName
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: XPN

id:
  v: PID.dateTimeofBirth
path:
  v: PID.dateTimeofBirth
short:
  v: dateTimeofBirth
definition:
  v: **DateTime of Birth**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.dateTimeofBirth
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: DTM

id:
  v: PID.administrativeSex
path:
  v: PID.administrativeSex
short:
  v: administrativeSex
definition:
  v: **Administrative Sex**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.administrativeSex
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CWE

id:
  v: PID.patientAlias
path:
  v: PID.patientAlias
short:
  v: patientAlias
definition:
  v: **Patient Alias**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.patientAlias
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: -

id:
  v: PID.race
path:
  v: PID.race
short:
  v: race
definition:
  v: **Race**
min:
  v: 0
max:
  v: *
base:
  path:
    v: PID.race
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CWE

id:
  v: PID.patientAddress
path:
  v: PID.patientAddress
short:
  v: patientAddress
definition:
  v: **Patient Address**
min:
  v: 0
max:
  v: *
base:
  path:
    v: PID.patientAddress
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: XAD

id:
  v: PID.countyCode
path:
  v: PID.countyCode
short:
  v: countyCode
definition:
  v: **County Code**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.countyCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: -

id:
  v: PID.phoneNumber-Home
path:
  v: PID.phoneNumber-Home
short:
  v: phoneNumber-Home
definition:
  v: **Phone Number - Home**
min:
  v: 0
max:
  v: *
base:
  path:
    v: PID.phoneNumber-Home
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: XTN

id:
  v: PID.phoneNumber-Business
path:
  v: PID.phoneNumber-Business
short:
  v: phoneNumber-Business
definition:
  v: **Phone Number - Business**
min:
  v: 0
max:
  v: *
base:
  path:
    v: PID.phoneNumber-Business
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: XTN

id:
  v: PID.primaryLanguage
path:
  v: PID.primaryLanguage
short:
  v: primaryLanguage
definition:
  v: **Primary Language**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.primaryLanguage
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CWE

id:
  v: PID.maritalStatus
path:
  v: PID.maritalStatus
short:
  v: maritalStatus
definition:
  v: **Marital Status**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.maritalStatus
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CWE

id:
  v: PID.religion
path:
  v: PID.religion
short:
  v: religion
definition:
  v: **Religion**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.religion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CWE

id:
  v: PID.patientAccountNumber
path:
  v: PID.patientAccountNumber
short:
  v: patientAccountNumber
definition:
  v: **Patient Account Number**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.patientAccountNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CX

id:
  v: PID.sSNNumber-Patient
path:
  v: PID.sSNNumber-Patient
short:
  v: sSNNumber-Patient
definition:
  v: **SSN Number - Patient**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.sSNNumber-Patient
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: -

id:
  v: PID.driversLicenseNumber-Patient
path:
  v: PID.driversLicenseNumber-Patient
short:
  v: driversLicenseNumber-Patient
definition:
  v: **Driver's License Number - Patient**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.driversLicenseNumber-Patient
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: -

id:
  v: PID.mothersIdentifier
path:
  v: PID.mothersIdentifier
short:
  v: mothersIdentifier
definition:
  v: **Mother's Identifier**
min:
  v: 0
max:
  v: *
base:
  path:
    v: PID.mothersIdentifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CX

id:
  v: PID.ethnicGroup
path:
  v: PID.ethnicGroup
short:
  v: ethnicGroup
definition:
  v: **Ethnic Group**
min:
  v: 0
max:
  v: *
base:
  path:
    v: PID.ethnicGroup
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CWE

id:
  v: PID.birthPlace
path:
  v: PID.birthPlace
short:
  v: birthPlace
definition:
  v: **Birth Place**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.birthPlace
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: ST

id:
  v: PID.multipleBirthIndicator
path:
  v: PID.multipleBirthIndicator
short:
  v: multipleBirthIndicator
definition:
  v: **Multiple Birth Indicator**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.multipleBirthIndicator
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: ID
max length:
  v: 1

id:
  v: PID.birthOrder
path:
  v: PID.birthOrder
short:
  v: birthOrder
definition:
  v: **Birth Order**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.birthOrder
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: NM

id:
  v: PID.citizenship
path:
  v: PID.citizenship
short:
  v: citizenship
definition:
  v: **Citizenship**
min:
  v: 0
max:
  v: *
base:
  path:
    v: PID.citizenship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CWE

id:
  v: PID.veteransMilitaryStatus
path:
  v: PID.veteransMilitaryStatus
short:
  v: veteransMilitaryStatus
definition:
  v: **Veterans Military Status**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.veteransMilitaryStatus
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CWE

id:
  v: PID.nationality
path:
  v: PID.nationality
short:
  v: nationality
definition:
  v: **Nationality**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.nationality
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CWE

id:
  v: PID.patientDeathDateandTime
path:
  v: PID.patientDeathDateandTime
short:
  v: patientDeathDateandTime
definition:
  v: **Patient Death Date and Time**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.patientDeathDateandTime
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: DTM

id:
  v: PID.patientDeathIndicator
path:
  v: PID.patientDeathIndicator
short:
  v: patientDeathIndicator
definition:
  v: **Patient Death Indicator**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.patientDeathIndicator
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: ID
max length:
  v: 1

id:
  v: PID.identityUnknownIndicator
path:
  v: PID.identityUnknownIndicator
short:
  v: identityUnknownIndicator
definition:
  v: **Identity Unknown Indicator**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.identityUnknownIndicator
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: ID
max length:
  v: 1

id:
  v: PID.identityReliabilityCode
path:
  v: PID.identityReliabilityCode
short:
  v: identityReliabilityCode
definition:
  v: **Identity Reliability Code**
min:
  v: 0
max:
  v: *
base:
  path:
    v: PID.identityReliabilityCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CWE

id:
  v: PID.lastUpdateDateTime
path:
  v: PID.lastUpdateDateTime
short:
  v: lastUpdateDateTime
definition:
  v: **Last Update DateTime**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.lastUpdateDateTime
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: DTM

id:
  v: PID.lastUpdateFacility
path:
  v: PID.lastUpdateFacility
short:
  v: lastUpdateFacility
definition:
  v: **Last Update Facility**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.lastUpdateFacility
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: HD

id:
  v: PID.taxonomicClassificationCode
path:
  v: PID.taxonomicClassificationCode
short:
  v: taxonomicClassificationCode
definition:
  v: **Taxonomic Classification Code**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.taxonomicClassificationCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CWE

id:
  v: PID.breedCode
path:
  v: PID.breedCode
short:
  v: breedCode
definition:
  v: **Breed Code**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.breedCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CWE

id:
  v: PID.strain
path:
  v: PID.strain
short:
  v: strain
definition:
  v: **Strain**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.strain
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: ST

id:
  v: PID.productionClassCode
path:
  v: PID.productionClassCode
short:
  v: productionClassCode
definition:
  v: **Production Class Code**
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PID.productionClassCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CWE

id:
  v: PID.tribalCitizenship
path:
  v: PID.tribalCitizenship
short:
  v: tribalCitizenship
definition:
  v: **Tribal Citizenship**
min:
  v: 0
max:
  v: *
base:
  path:
    v: PID.tribalCitizenship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CWE

id:
  v: PID.patientTelecommunicationInformation
path:
  v: PID.patientTelecommunicationInformation
short:
  v: patientTelecommunicationInformation
definition:
  v: **Patient Telecommunication Information**
min:
  v: 0
max:
  v: *
base:
  path:
    v: PID.patientTelecommunicationInformation
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: XTN

element:
  id:
    v: PID
  path:
    v: PID
  definition:
    v: Patient Identification
  min:
    v: 1
  max:
    v: 1
element:
  id:
    v: PID.setID-PID
  path:
    v: PID.setID-PID
  short:
    v: setID-PID
  definition:
    v: **Set ID - PID**
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: SI
  max length:
    v: 4
element:
  id:
    v: PID.patientID
  path:
    v: PID.patientID
  short:
    v: patientID
  definition:
    v: **Patient ID**
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: -
element:
  id:
    v: PID.patientIdentifierList
  path:
    v: PID.patientIdentifierList
  short:
    v: patientIdentifierList
  definition:
    v: **Patient Identifier List**
  min:
    v: 1
  max:
    v: *
  type:
    code:
      v: CX
  must support:
    v: true
element:
  id:
    v: PID.alternatePatientID-PID
  path:
    v: PID.alternatePatientID-PID
  short:
    v: alternatePatientID-PID
  definition:
    v: **Alternate Patient ID - PID**
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: -
element:
  id:
    v: PID.patientName
  path:
    v: PID.patientName
  short:
    v: patientName
  definition:
    v: **Patient Name**
  min:
    v: 1
  max:
    v: *
  type:
    code:
      v: XPN
  must support:
    v: true
element:
  id:
    v: PID.mothersMaidenName
  path:
    v: PID.mothersMaidenName
  short:
    v: mothersMaidenName
  definition:
    v: **Mother's Maiden Name**
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: XPN
element:
  id:
    v: PID.dateTimeofBirth
  path:
    v: PID.dateTimeofBirth
  short:
    v: dateTimeofBirth
  definition:
    v: **DateTime of Birth**
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: DTM
element:
  id:
    v: PID.administrativeSex
  path:
    v: PID.administrativeSex
  short:
    v: administrativeSex
  definition:
    v: **Administrative Sex**
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: CWE
element:
  id:
    v: PID.patientAlias
  path:
    v: PID.patientAlias
  short:
    v: patientAlias
  definition:
    v: **Patient Alias**
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: -
element:
  id:
    v: PID.race
  path:
    v: PID.race
  short:
    v: race
  definition:
    v: **Race**
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: CWE
element:
  id:
    v: PID.patientAddress
  path:
    v: PID.patientAddress
  short:
    v: patientAddress
  definition:
    v: **Patient Address**
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: XAD
element:
  id:
    v: PID.countyCode
  path:
    v: PID.countyCode
  short:
    v: countyCode
  definition:
    v: **County Code**

v: 0

v: 1

code:
  v: -

id:
  v: PID.phoneNumber-Home
path:
  v: PID.phoneNumber-Home
short:
  v: phoneNumber-Home
definition:
  v: **Phone Number - Home**
min:
  v: 0
max:
  v: *
type:
  code:
    v: XTN

id:
  v: PID.phoneNumber-Business
path:
  v: PID.phoneNumber-Business
short:
  v: phoneNumber-Business
definition:
  v: **Phone Number - Business**
min:
  v: 0
max:
  v: *
type:
  code:
    v: XTN

id:
  v: PID.primaryLanguage
path:
  v: PID.primaryLanguage
short:
  v: primaryLanguage
definition:
  v: **Primary Language**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CWE

id:
  v: PID.maritalStatus
path:
  v: PID.maritalStatus
short:
  v: maritalStatus
definition:
  v: **Marital Status**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CWE

id:
  v: PID.religion
path:
  v: PID.religion
short:
  v: religion
definition:
  v: **Religion**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CWE

id:
  v: PID.patientAccountNumber
path:
  v: PID.patientAccountNumber
short:
  v: patientAccountNumber
definition:
  v: **Patient Account Number**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CX

id:
  v: PID.sSNNumber-Patient
path:
  v: PID.sSNNumber-Patient
short:
  v: sSNNumber-Patient
definition:
  v: **SSN Number - Patient**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: -

id:
  v: PID.driversLicenseNumber-Patient
path:
  v: PID.driversLicenseNumber-Patient
short:
  v: driversLicenseNumber-Patient
definition:
  v: **Driver's License Number - Patient**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: -

id:
  v: PID.mothersIdentifier
path:
  v: PID.mothersIdentifier
short:
  v: mothersIdentifier
definition:
  v: **Mother's Identifier**
min:
  v: 0
max:
  v: *
type:
  code:
    v: CX

id:
  v: PID.ethnicGroup
path:
  v: PID.ethnicGroup
short:
  v: ethnicGroup
definition:
  v: **Ethnic Group**
min:
  v: 0
max:
  v: *
type:
  code:
    v: CWE

id:
  v: PID.birthPlace
path:
  v: PID.birthPlace
short:
  v: birthPlace
definition:
  v: **Birth Place**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: ST

id:
  v: PID.multipleBirthIndicator
path:
  v: PID.multipleBirthIndicator
short:
  v: multipleBirthIndicator
definition:
  v: **Multiple Birth Indicator**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: ID
max length:
  v: 1

id:
  v: PID.birthOrder
path:
  v: PID.birthOrder
short:
  v: birthOrder
definition:
  v: **Birth Order**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: NM

id:
  v: PID.citizenship
path:
  v: PID.citizenship
short:
  v: citizenship
definition:
  v: **Citizenship**
min:
  v: 0
max:
  v: *
type:
  code:
    v: CWE

id:
  v: PID.veteransMilitaryStatus
path:
  v: PID.veteransMilitaryStatus
short:
  v: veteransMilitaryStatus
definition:
  v: **Veterans Military Status**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CWE

id:
  v: PID.nationality
path:
  v: PID.nationality
short:
  v: nationality
definition:
  v: **Nationality**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CWE

id:
  v: PID.patientDeathDateandTime
path:
  v: PID.patientDeathDateandTime
short:
  v: patientDeathDateandTime
definition:
  v: **Patient Death Date and Time**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: DTM

id:
  v: PID.patientDeathIndicator
path:
  v: PID.patientDeathIndicator
short:
  v: patientDeathIndicator
definition:
  v: **Patient Death Indicator**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: ID
max length:
  v: 1

id:
  v: PID.identityUnknownIndicator
path:
  v: PID.identityUnknownIndicator
short:
  v: identityUnknownIndicator
definition:
  v: **Identity Unknown Indicator**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: ID
max length:
  v: 1

id:
  v: PID.identityReliabilityCode
path:
  v: PID.identityReliabilityCode
short:
  v: identityReliabilityCode
definition:
  v: **Identity Reliability Code**
min:
  v: 0
max:
  v: *
type:
  code:
    v: CWE

id:
  v: PID.lastUpdateDateTime
path:
  v: PID.lastUpdateDateTime
short:
  v: lastUpdateDateTime
definition:
  v: **Last Update DateTime**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: DTM

id:
  v: PID.lastUpdateFacility
path:
  v: PID.lastUpdateFacility
short:
  v: lastUpdateFacility
definition:
  v: **Last Update Facility**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: HD

id:
  v: PID.taxonomicClassificationCode
path:
  v: PID.taxonomicClassificationCode
short:
  v: taxonomicClassificationCode
definition:
  v: **Taxonomic Classification Code**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CWE

id:
  v: PID.breedCode
path:
  v: PID.breedCode
short:
  v: breedCode
definition:
  v: **Breed Code**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CWE

id:
  v: PID.strain
path:
  v: PID.strain
short:
  v: strain
definition:
  v: **Strain**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: ST

id:
  v: PID.productionClassCode
path:
  v: PID.productionClassCode
short:
  v: productionClassCode
definition:
  v: **Production Class Code**
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CWE

id:
  v: PID.tribalCitizenship
path:
  v: PID.tribalCitizenship
short:
  v: tribalCitizenship
definition:
  v: **Tribal Citizenship**
min:
  v: 0
max:
  v: *
type:
  code:
    v: CWE

id:
  v: PID.patientTelecommunicationInformation
path:
  v: PID.patientTelecommunicationInformation
short:
  v: patientTelecommunicationInformation
definition:
  v: **Patient Telecommunication Information**
min:
  v: 0
max:
  v: *
type:
  code:
    v: XTN