description: This abstract Patient profile includes common extensions and slicing used across vital records.
package_name: hl7.fhir.us.vr-common-library
derivation: constraint
name: PatientVitalRecords
abstract: true
type: Patient
elements:
  extension:
    type: Extension
    short: Place of Birth for the patient should include the state and/or country
    url: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    index: 0
    slicing:
      slices:
        birthPlace:
          match: {}
          schema:
            type: Extension
            short: Place of Birth for the patient should include the state and/or country
            url: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
            index: 0
            elements:
              value[x]:
                elements:
                  city:
                    extensions:
                      cityCode: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode', min: 0, max: 1, type: Extension, index: 2}
                    elements:
                      extension:
                        index: 1
                        slicing:
                          rules: open
                          ordered: false
                          discriminator:
                          - {path: url, type: value}
                          min: null
                          slices:
                            cityCode:
                              match: {url: null}
                              schema: {type: Extension, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode', index: 2}
                              min: 0
                              max: 1
                  district:
                    extensions:
                      districtCode: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode', min: 0, max: 1, short: County code, type: Extension, label: County code, index: 4}
                    elements:
                      extension:
                        index: 3
                        slicing:
                          rules: open
                          ordered: false
                          discriminator:
                          - {path: url, type: value}
                          min: null
                          slices:
                            districtCode:
                              match: {url: null}
                              schema: {short: County code, type: Extension, label: County code, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode', index: 4}
                              min: 0
                              max: 1
                  state:
                    binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr'}
                    index: 5
                  country:
                    binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr'}
                    index: 6
        parentReportedAgeAtDelivery:
          match: {}
          schema: {type: Extension, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr', index: 7}
          min: 0
          max: 2
        fetalDeath:
          match: {}
          schema: {type: Extension, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr', index: 8}
          min: 0
          max: 1
  identifier:
    index: 9
    slicing:
      rules: open
      ordered: false
      description: Slice based on ID type
      discriminator:
      - {path: type, type: pattern}
      min: null
      slices:
        MRN:
          match:
            type:
              coding:
              - {code: MR, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
          schema:
            short: Medical Record Number
            array: true
            index: 10
            elements:
              type:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: MR, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
                index: 11
            required: [type]
        SSN:
          match:
            type:
              coding:
              - {code: SS, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
          schema:
            short: SSN if available and appropriate to send
            index: 12
            elements:
              type:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: SS, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
                index: 13
              system:
                pattern: {type: Uri, value: 'http://hl7.org/fhir/sid/us-ssn'}
                index: 14
            required: [type]
  name:
    index: 15
    elements:
      use: {index: 16}
      family:
        index: 17
        extensions:
          dataAbsentReason: {url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', min: 0, max: 1, type: Extension, index: 19}
        elements:
          extension:
            index: 18
            slicing:
              rules: open
              discriminator:
              - {path: url, type: value}
              min: null
              slices:
                dataAbsentReason:
                  match: {url: null}
                  schema: {type: Extension, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', index: 19}
                  min: 0
                  max: 1
      given:
        extensions:
          dataAbsentReason: {url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', min: 0, max: 1, type: Extension, index: 21}
        elements:
          extension:
            index: 20
            slicing:
              rules: open
              discriminator:
              - {path: url, type: value}
              min: null
              slices:
                dataAbsentReason:
                  match: {url: null}
                  schema: {type: Extension, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', index: 21}
                  min: 0
                  max: 1
    required: [family, use]
    slicing:
      rules: open
      discriminator:
      - {path: use, type: value}
      min: null
      slices:
        currentLegalName:
          match: {use: official}
          schema:
            short: current legal name
            index: 22
            elements:
              use:
                pattern: {type: Code, value: official}
                index: 23
              family: {index: 24}
            required: [family, use]
        namePriorToFirstMarriage:
          match: {use: maiden}
          schema:
            short: Name prior to first marriage
            index: 25
            elements:
              use:
                pattern: {type: Code, value: maiden}
                index: 26
              family: {index: 27}
            required: [family, use]
  birthDate:
    extensions:
      partialDateTime: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords', min: 0, max: 1, type: Extension, short: partialDateTIme, index: 29}
      birthTime: {url: 'http://hl7.org/fhir/StructureDefinition/patient-birthTime', min: 0, max: 1, type: Extension, index: 30}
      bypassEditFlag:
        url: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
        type: Extension
        index: 31
        elements:
          value:
            short: To reflect the relevant edit possibilities for date of birth.
            choices: []
            index: 33
    elements:
      extension:
        index: 28
        slicing:
          rules: open
          ordered: false
          discriminator:
          - {path: url, type: value}
          min: null
          slices:
            partialDateTime:
              match: {url: null}
              schema: {type: Extension, short: partialDateTIme, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords', index: 29}
              min: 0
              max: 1
            birthTime:
              match: {url: null}
              schema: {type: Extension, url: 'http://hl7.org/fhir/StructureDefinition/patient-birthTime', index: 30}
              min: 0
              max: 1
            bypassEditFlag:
              match: {url: null}
              schema:
                type: Extension
                url: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
                index: 31
                elements:
                  value:
                    short: To reflect the relevant edit possibilities for date of birth.
                    choices: []
                    index: 33
  address:
    extensions:
      withinCityLimitsIndicator: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr', min: 0, max: 1, type: Extension, short: Used to indicate whether or not an address is within city limits., index: 34}
      predir: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional', min: 0, max: 1, type: Extension, index: 35}
      stnum: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber', min: 0, max: 1, type: Extension, index: 36}
      stname: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName', min: 0, max: 1, type: Extension, index: 37}
      stdesig: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator', min: 0, max: 1, type: Extension, index: 38}
      postdir: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional', min: 0, max: 1, type: Extension, index: 39}
      unitnumber: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber', min: 0, max: 1, type: Extension, index: 40}
    elements:
      extension:
        type: Extension
        short: Used to indicate whether or not an address is within city limits.
        url: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
        index: 34
        slicing:
          slices:
            withinCityLimitsIndicator:
              match: {}
              schema: {type: Extension, short: Used to indicate whether or not an address is within city limits., url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr', index: 34}
              min: 0
              max: 1
            predir:
              match: {}
              schema: {type: Extension, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional', index: 35}
              min: 0
              max: 1
            stnum:
              match: {}
              schema: {type: Extension, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber', index: 36}
              min: 0
              max: 1
            stname:
              match: {}
              schema: {type: Extension, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName', index: 37}
              min: 0
              max: 1
            stdesig:
              match: {}
              schema: {type: Extension, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator', index: 38}
              min: 0
              max: 1
            postdir:
              match: {}
              schema: {type: Extension, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional', index: 39}
              min: 0
              max: 1
            unitnumber:
              match: {}
              schema: {type: Extension, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber', index: 40}
              min: 0
              max: 1
      city:
        extensions:
          cityCode: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode', min: 0, max: 1, short: City Code, type: Extension, label: City Code, index: 42}
        elements:
          extension:
            index: 41
            slicing:
              rules: open
              ordered: false
              discriminator:
              - {path: url, type: value}
              min: null
              slices:
                cityCode:
                  match: {url: null}
                  schema: {short: City Code, type: Extension, label: City Code, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode', index: 42}
                  min: 0
                  max: 1
      district:
        extensions:
          districtCode: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode', min: 0, max: 1, short: County code, type: Extension, label: County code, index: 44}
        elements:
          extension:
            index: 43
            slicing:
              rules: open
              ordered: false
              discriminator:
              - {path: url, type: value}
              min: null
              slices:
                districtCode:
                  match: {url: null}
                  schema: {short: County code, type: Extension, label: County code, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode', index: 44}
                  min: 0
                  max: 1
      state:
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr'}
        index: 45
      country:
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr'}
        index: 46
  multipleBirth:
    extensions: {}
    elements:
      extension:
        elements:
          value:
            choices: []
            index: 51
  multipleBirth[x]:
    extensions:
      multipleBirthTotal: {url: 'http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal', min: 0, max: 1, type: Extension, index: 52}
    elements:
      extension:
        type: Extension
        url: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
        index: 52
        slicing:
          slices:
            multipleBirthTotal:
              match: {}
              schema: {type: Extension, url: 'http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal', index: 52}
              min: 0
              max: 1
package_version: 2.0.0-ballot
extensions:
  birthPlace:
    url: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    type: Extension
    short: Place of Birth for the patient should include the state and/or country
    index: 0
    elements:
      value[x]:
        elements:
          city:
            extensions:
              cityCode: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode', min: 0, max: 1, type: Extension, index: 2}
            elements:
              extension:
                index: 1
                slicing:
                  rules: open
                  ordered: false
                  discriminator:
                  - {path: url, type: value}
                  min: null
                  slices:
                    cityCode:
                      match: {url: null}
                      schema: {type: Extension, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode', index: 2}
                      min: 0
                      max: 1
          district:
            extensions:
              districtCode: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode', min: 0, max: 1, short: County code, type: Extension, label: County code, index: 4}
            elements:
              extension:
                index: 3
                slicing:
                  rules: open
                  ordered: false
                  discriminator:
                  - {path: url, type: value}
                  min: null
                  slices:
                    districtCode:
                      match: {url: null}
                      schema: {short: County code, type: Extension, label: County code, url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode', index: 4}
                      min: 0
                      max: 1
          state:
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr'}
            index: 5
          country:
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr'}
            index: 6
  parentReportedAgeAtDelivery: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr', min: 0, max: 2, type: Extension, index: 7}
  fetalDeath: {url: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr', min: 0, max: 1, type: Extension, index: 8}
class: profile
kind: resource
url: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-vr
base: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
version: 2.0.0-ballot