description: This Patient profile represents a US Public Health Patient.
package_name: hl7.fhir.us.ph-library
derivation: constraint
name: USPublicHealthPatient
type: Patient
elements:
  address:
    short: (USCDI+) Current Address
    index: 40
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        type: Extension
        mustSupport: true
        index: 41
        elements:
          value:
            pattern: {type: code, value: masked}
            mustSupport: true
            choices: []
            type: code
            index: 43
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        index: 41
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                index: 41
                elements:
                  value:
                    pattern: {type: code, value: masked}
                    mustSupport: true
                    choices: []
                    type: code
                    index: 43
      district: {short: County, mustSupport: true, index: 44}
  name:
    short: (USCDI+) Patient Name
    index: 15
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        type: Extension
        mustSupport: true
        index: 16
        elements:
          value:
            pattern: {type: code, value: masked}
            mustSupport: true
            choices: []
            type: code
            index: 18
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        index: 16
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                index: 16
                elements:
                  value:
                    pattern: {type: code, value: masked}
                    mustSupport: true
                    choices: []
                    type: code
                    index: 18
  birthDate:
    short: (USCDI+) Date of Birth
    index: 33
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        type: Extension
        mustSupport: true
        index: 35
        elements:
          value:
            pattern: {type: code, value: masked}
            mustSupport: true
            choices: []
            type: code
            index: 37
    elements:
      extension:
        index: 34
        slicing:
          rules: open
          ordered: false
          discriminator:
          - {path: url, type: value}
          min: null
          slices:
            dataAbsentReason:
              match: {url: null}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                index: 35
                elements:
                  value:
                    pattern: {type: code, value: masked}
                    mustSupport: true
                    choices: []
                    type: code
                    index: 37
  deceased:
    short: If patient is deceased, use type dateTime and set to deceased date.
    mustSupport: true
    choices: []
    index: 39
  extension:
    array: true
    min: 2
    index: 0
    slicing:
      slices:
        race:
          match: {}
          schema:
            short: (USCDI+) Race (US Core Race Extension)
            mustSupport: true
            _required: true
            index: 1
            extensions:
              dataAbsentReason:
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                type: Extension
                short: For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked"
                mustSupport: true
                index: 2
                elements:
                  value:
                    pattern: {type: code, value: masked}
                    mustSupport: true
                    choices: []
                    type: code
                    index: 4
            elements:
              extension:
                type: Extension
                short: For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked"
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                index: 2
                slicing:
                  slices:
                    dataAbsentReason:
                      match: {}
                      schema:
                        type: Extension
                        short: For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked"
                        mustSupport: true
                        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                        index: 2
                        elements:
                          value:
                            pattern: {type: code, value: masked}
                            mustSupport: true
                            choices: []
                            type: code
                            index: 4
        ethnicity:
          match: {}
          schema:
            short: (USCDI+) Ethnicity (US Core Ethnicity Extension)
            mustSupport: true
            _required: true
            index: 5
            extensions:
              dataAbsentReason:
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                type: Extension
                short: For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked"
                mustSupport: true
                index: 6
                elements:
                  value:
                    pattern: {type: code, value: masked}
                    mustSupport: true
                    choices: []
                    type: code
                    index: 8
            elements:
              extension:
                type: Extension
                short: For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked"
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                index: 6
                slicing:
                  slices:
                    dataAbsentReason:
                      match: {}
                      schema:
                        type: Extension
                        short: For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked"
                        mustSupport: true
                        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                        index: 6
                        elements:
                          value:
                            pattern: {type: code, value: masked}
                            mustSupport: true
                            choices: []
                            type: code
                            index: 8
        tribalAffiliation:
          match: {}
          schema: {short: '(USCDI+) Tribal Affiliation, (USCDI+) Tribal Enrollment (US Core Tribal Affiliation Extension)', mustSupport: true, index: 9}
        birthPlace:
          match: {}
          schema: {type: Extension, short: (USCDI+) Patient Birth Place (FHIR Patient Birth Place Extension), mustSupport: true, url: 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace|5.2.0', index: 10}
          min: 0
          max: 1
  communication:
    mustSupport: true
    index: 59
    elements:
      language:
        short: (USCDI+) Preferred Language
        index: 60
        extensions:
          dataAbsentReason:
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
            type: Extension
            mustSupport: true
            index: 61
            elements:
              value:
                pattern: {type: code, value: masked}
                mustSupport: true
                choices: []
                type: code
                index: 63
        elements:
          extension:
            type: Extension
            mustSupport: true
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
            index: 61
            slicing:
              slices:
                dataAbsentReason:
                  match: {}
                  schema:
                    type: Extension
                    mustSupport: true
                    url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                    index: 61
                    elements:
                      value:
                        pattern: {type: code, value: masked}
                        mustSupport: true
                        choices: []
                        type: code
                        index: 63
  identifier:
    short: (USCDI+) Patient Identifier, (USCDI+) Medical Record Number, (USCDI+) Medicare Patient Identifier
    index: 11
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        type: Extension
        index: 12
        elements:
          value:
            pattern: {type: code, value: masked}
            mustSupport: true
            choices: []
            type: code
            index: 14
    elements:
      extension:
        type: Extension
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        index: 12
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                index: 12
                elements:
                  value:
                    pattern: {type: code, value: masked}
                    mustSupport: true
                    choices: []
                    type: code
                    index: 14
  telecom:
    mustSupport: true
    index: 19
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        type: Extension
        mustSupport: true
        index: 20
        elements:
          value:
            pattern: {type: code, value: masked}
            mustSupport: true
            choices: []
            type: code
            index: 22
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        index: 20
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                index: 20
                elements:
                  value:
                    pattern: {type: code, value: masked}
                    mustSupport: true
                    choices: []
                    type: code
                    index: 22
    slicing:
      rules: open
      discriminator:
      - {path: system, type: value}
      min: 1
      slices:
        phone:
          match: {system: phone}
          schema:
            short: (USCDI+) Phone Number
            mustSupport: true
            array: true
            index: 23
            extensions:
              dataAbsentReason: {url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0', min: 0, max: 1, type: Extension, mustSupport: true, index: 24}
            elements:
              extension:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                index: 24
                slicing:
                  slices:
                    dataAbsentReason:
                      match: {}
                      schema: {type: Extension, mustSupport: true, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0', index: 24}
                      min: 0
                      max: 1
              system:
                pattern: {type: code, value: phone}
                type: code
                index: 25
        email:
          match: {system: email}
          schema:
            short: (USCDI+) Email Address
            mustSupport: true
            array: true
            index: 26
            extensions:
              dataAbsentReason: {url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0', min: 0, max: 1, type: Extension, mustSupport: true, index: 27}
            elements:
              extension:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                index: 27
                slicing:
                  slices:
                    dataAbsentReason:
                      match: {}
                      schema: {type: Extension, mustSupport: true, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0', index: 27}
                      min: 0
                      max: 1
              system:
                pattern: {type: code, value: email}
                type: code
                index: 28
  gender:
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        type: Extension
        mustSupport: true
        index: 30
        elements:
          value:
            pattern: {type: code, value: masked}
            mustSupport: true
            choices: []
            type: code
            index: 32
    elements:
      extension:
        index: 29
        slicing:
          rules: open
          ordered: false
          discriminator:
          - {path: url, type: value}
          min: null
          slices:
            dataAbsentReason:
              match: {url: null}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                index: 30
                elements:
                  value:
                    pattern: {type: code, value: masked}
                    mustSupport: true
                    choices: []
                    type: code
                    index: 32
  contact:
    mustSupport: true
    index: 45
    elements:
      relationship: {short: '(USCDI+) Relationship Type, Parent/Guardian Code', mustSupport: true, index: 46}
      name:
        short: (USCDI+) Parent/Guardian Name
        mustSupport: true
        index: 47
        extensions:
          dataAbsentReason:
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
            type: Extension
            mustSupport: true
            index: 48
            elements:
              value:
                pattern: {type: code, value: masked}
                mustSupport: true
                choices: []
                type: code
                index: 50
        elements:
          extension:
            type: Extension
            mustSupport: true
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
            index: 48
            slicing:
              slices:
                dataAbsentReason:
                  match: {}
                  schema:
                    type: Extension
                    mustSupport: true
                    url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                    index: 48
                    elements:
                      value:
                        pattern: {type: code, value: masked}
                        mustSupport: true
                        choices: []
                        type: code
                        index: 50
      telecom:
        mustSupport: true
        index: 51
        extensions:
          dataAbsentReason:
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
            type: Extension
            mustSupport: true
            index: 52
            elements:
              value:
                pattern: {type: code, value: masked}
                mustSupport: true
                choices: []
                type: code
                index: 54
        elements:
          extension:
            type: Extension
            mustSupport: true
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
            index: 52
            slicing:
              slices:
                dataAbsentReason:
                  match: {}
                  schema:
                    type: Extension
                    mustSupport: true
                    url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                    index: 52
                    elements:
                      value:
                        pattern: {type: code, value: masked}
                        mustSupport: true
                        choices: []
                        type: code
                        index: 54
      address:
        short: Parent/Guardian Address
        mustSupport: true
        index: 55
        extensions:
          dataAbsentReason:
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
            type: Extension
            mustSupport: true
            index: 56
            elements:
              value:
                pattern: {type: code, value: masked}
                mustSupport: true
                choices: []
                type: code
                index: 58
        elements:
          extension:
            type: Extension
            mustSupport: true
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
            index: 56
            slicing:
              slices:
                dataAbsentReason:
                  match: {}
                  schema:
                    type: Extension
                    mustSupport: true
                    url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                    index: 56
                    elements:
                      value:
                        pattern: {type: code, value: masked}
                        mustSupport: true
                        choices: []
                        type: code
                        index: 58
    required: [address, name, relationship, telecom]
package_version: 2.0.0-ballot
extensions:
  race:
    url: null
    short: (USCDI+) Race (US Core Race Extension)
    mustSupport: true
    _required: true
    index: 1
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        type: Extension
        short: For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked"
        mustSupport: true
        index: 2
        elements:
          value:
            pattern: {type: code, value: masked}
            mustSupport: true
            choices: []
            type: code
            index: 4
    elements:
      extension:
        type: Extension
        short: For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked"
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        index: 2
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                short: For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked"
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                index: 2
                elements:
                  value:
                    pattern: {type: code, value: masked}
                    mustSupport: true
                    choices: []
                    type: code
                    index: 4
  ethnicity:
    url: null
    short: (USCDI+) Ethnicity (US Core Ethnicity Extension)
    mustSupport: true
    _required: true
    index: 5
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        type: Extension
        short: For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked"
        mustSupport: true
        index: 6
        elements:
          value:
            pattern: {type: code, value: masked}
            mustSupport: true
            choices: []
            type: code
            index: 8
    elements:
      extension:
        type: Extension
        short: For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked"
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
        index: 6
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                short: For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked"
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.2.0
                index: 6
                elements:
                  value:
                    pattern: {type: code, value: masked}
                    mustSupport: true
                    choices: []
                    type: code
                    index: 8
  tribalAffiliation: {url: null, short: '(USCDI+) Tribal Affiliation, (USCDI+) Tribal Enrollment (US Core Tribal Affiliation Extension)', mustSupport: true, index: 9}
  birthPlace: {url: 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace|5.2.0', min: 0, max: 1, type: Extension, short: (USCDI+) Patient Birth Place (FHIR Patient Birth Place Extension), mustSupport: true, index: 10}
class: profile
kind: resource
url: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-patient
base: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
version: 2.0.0-ballot
required: [address, birthDate, communication, deceased, telecom]