description: The US Core Patient Profile meets the U.S. Core Data for Interoperability (USCDI) v3 'Patient Demographics' requirements. This profile sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource when using this profile to promote interoperability and adoption through common implementation.  It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource and constrains the way the elements are used when using this profile.  It provides the floor for standards development for specific use cases.
package_name: hl7.fhir.us.core.r4
derivation: constraint
name: USCorePatientProfile
type: Patient
elements:
  address:
    mustSupport: true
    index: 23
    elements:
      use: {short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address', index: 24}
      line: {mustSupport: true, index: 25}
      city: {mustSupport: true, index: 26}
      state:
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'}
        mustSupport: true
        index: 27
      postalCode: {short: US Zip Codes, mustSupport: true, index: 28}
      period: {short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use', index: 29}
  name:
    constraint:
      us-core-6: {human: 'At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.', severity: error, expression: '(family.exists() or given.exists()) xor extension.where(url=''http://hl7.org/fhir/StructureDefinition/data-absent-reason'').exists()'}
    mustSupport: true
    index: 9
    elements:
      use: {short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden', index: 10}
      family: {mustSupport: true, index: 11}
      given: {mustSupport: true, index: 12}
      suffix: {short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name', mustSupport: false, index: 13}
      period: {short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use', mustSupport: false, index: 14}
  birthDate: {mustSupport: true, index: 20}
  deceased:
    short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not'
    choices: []
    index: 22
  extension:
    short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension'
    type: Extension
    mustSupport: false
    url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
    index: 0
    slicing:
      slices:
        race:
          match: {}
          schema: {short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension', type: Extension, mustSupport: false, url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race', index: 0}
          min: 0
          max: 1
        ethnicity:
          match: {}
          schema: {short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension', type: Extension, mustSupport: false, url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity', index: 1}
          min: 0
          max: 1
        tribalAffiliation:
          match: {}
          schema: {short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension', type: Extension, mustSupport: false, url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation', index: 2}
          min: 0
        birthsex:
          match: {}
          schema: {short: Birth Sex Extension, type: Extension, mustSupport: false, url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex', index: 3}
          min: 0
          max: 1
        sex:
          match: {}
          schema: {short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension', type: Extension, mustSupport: false, url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex', index: 4}
          min: 0
          max: 1
        genderIdentity:
          match: {}
          schema: {short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual''s gender identity', type: Extension, mustSupport: false, url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity', index: 5}
          min: 0
  communication:
    short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health'
    mustSupport: false
    index: 30
    elements:
      language:
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/us/core/ValueSet/simple-language'}
        mustSupport: true
        index: 31
  identifier:
    mustSupport: true
    index: 6
    elements:
      system: {mustSupport: true, index: 7}
      value: {short: The value that is unique within the system., mustSupport: true, index: 8}
    required: [value, system]
  telecom:
    short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual'
    mustSupport: false
    index: 15
    elements:
      system:
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/contact-point-system'}
        mustSupport: true
        index: 16
      value: {mustSupport: true, index: 17}
      use:
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/contact-point-use'}
        mustSupport: true
        index: 18
    required: [value, system]
  gender:
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/administrative-gender'}
    mustSupport: true
    index: 19
package_version: 7.0.0-ballot
extensions:
  race: {url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race', min: 0, max: 1, short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension', type: Extension, mustSupport: false, index: 0}
  ethnicity: {url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity', min: 0, max: 1, short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension', type: Extension, mustSupport: false, index: 1}
  tribalAffiliation: {url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation', min: 0, short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension', type: Extension, mustSupport: false, index: 2}
  birthsex: {url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex', min: 0, max: 1, short: Birth Sex Extension, type: Extension, mustSupport: false, index: 3}
  sex: {url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex', min: 0, max: 1, short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension', type: Extension, mustSupport: false, index: 4}
  genderIdentity: {url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity', min: 0, short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual''s gender identity', type: Extension, mustSupport: false, index: 5}
class: profile
kind: resource
url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
base: http://hl7.org/fhir/StructureDefinition/Patient
version: 7.0.0-ballot
required: [gender, name, identifier]