PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.us.core@6.1.0-snapshot1
    http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
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
derivation: constraint
name: USCorePatientProfile
type: Patient
elements:
  address:
    short: (USCDI) An address for the individual
    mustSupport: true
    index: 23
    elements:
      use: {short: (USCDI) home | work | temp | old | billing - purpose of this address, index: 24}
      line: {short: '(USCDI) Street name, number, direction & P.O. Box etc.', mustSupport: true, index: 25}
      city: {short: '(USCDI) Name of city, town etc.', mustSupport: true, index: 26}
      state:
        short: (USCDI) Sub-unit of country (abbreviations ok)
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'}
        mustSupport: true
        index: 27
      postalCode: {short: (USCDI) US Zip Codes, mustSupport: true, index: 28}
      period: {short: (USCDI) Time period when address was/is in use, index: 29}
  name:
    short: (USCDI) A name associated with the patient
    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: (USCDI) usual | official | temp | nickname | anonymous | old | maiden, index: 10}
      family: {short: (USCDI) Family name (often called 'Surname'), mustSupport: true, index: 11}
      given: {short: (USCDI) Given names (not always 'first'). Includes middle names, mustSupport: true, index: 12}
      suffix: {short: (USCDI) Parts that come after the name, mustSupport: false, index: 13}
      period: {short: (USCDI) Time period when name was/is in use, mustSupport: false, index: 14}
  birthDate: {short: (USCDI) The date of birth for the individual, mustSupport: true, index: 20}
  deceased:
    short: (USCDI) Indicates if the individual is deceased or not
    choices: []
    index: 22
  extension:
    short: (USCDI) 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: (USCDI) 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: (USCDI) 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: (USCDI) 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: (USCDI) 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: (USCDI) 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: (USCDI) A language which may be used to communicate with the patient about his or her health
    mustSupport: false
    index: 30
    elements:
      language:
        short: (USCDI) The language which can be used to communicate with the patient about his or her health
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/us/core/ValueSet/simple-language'}
        mustSupport: true
        index: 31
  identifier:
    short: (USCDI) An identifier for this patient
    mustSupport: true
    index: 6
    elements:
      system: {short: (USCDI) The namespace for the identifier value, mustSupport: true, index: 7}
      value: {short: (USCDI) The value that is unique within the system., mustSupport: true, index: 8}
    required: [value, system]
  telecom:
    short: (USCDI) A contact detail for the individual
    mustSupport: false
    index: 15
    elements:
      system:
        short: (USCDI) phone | fax | email | pager | url | sms | other
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/contact-point-system'}
        mustSupport: true
        index: 16
      value: {short: (USCDI) The actual contact point details, mustSupport: true, index: 17}
      use:
        short: (USCDI) home | work | temp | old | mobile - purpose of this contact point
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/contact-point-use'}
        mustSupport: true
        index: 18
    required: [value, system]
  gender:
    short: (USCDI) male | female | other | unknown
    type: code
    mustSupport: true
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/administrative-gender'}
    index: 19
package_version: 6.1.0-snapshot1
extensions:
  race: {url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race', min: 0, max: 1, short: (USCDI) 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: (USCDI) 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: (USCDI) 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: (USCDI) Sex Extension, type: Extension, mustSupport: false, index: 4}
  genderIdentity: {url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity', min: 0, short: (USCDI) 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: 6.1.0-snapshot1
required: [gender, name, identifier]