description: This Patient profile represents a US Public Health Patient.\n\nIt is based on the **US Core Patient** profile with further constraints to require and/or allow masking of some data elements,  and the addition of the US Public Health Gender Identity extension.\n\nFor ONC’s USCDI requirements, it also adds Must Support constraints to the following:\n\n* contact detail (e.g. a telephone number or an email address)\n* a communication language\n* a race\n* an ethnicity\n* a birth sex
package_name: hl7.fhir.us.ecr.r4
derivation: constraint
name: USPublicHealthPatient
type: Patient
elements:
  address:
    mustSupport: true
    index: 45
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        type: Extension
        mustSupport: true
        index: 46
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 48
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 49
        required: [valueCode, value]
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 46
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                index: 46
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 48
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 49
                required: [valueCode, value]
      district: {short: County, mustSupport: true, index: 50}
  name:
    index: 19
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        type: Extension
        mustSupport: true
        index: 20
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 22
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 23
        required: [valueCode, value]
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 20
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                index: 20
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 22
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 23
                required: [valueCode, value]
  birthDate:
    mustSupport: true
    index: 38
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        type: Extension
        mustSupport: true
        index: 39
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 41
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 42
        required: [valueCode, value]
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 39
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                index: 39
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 41
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 42
                required: [valueCode, value]
  deceased:
    short: If patient is deceased, use type dateTime and set to deceased date.
    mustSupport: true
    choices: []
    index: 44
  extension:
    mustSupport: true
    index: 0
    slicing:
      slices:
        race:
          match: {}
          schema:
            mustSupport: true
            _required: true
            index: 0
            extensions:
              dataAbsentReason:
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                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: 1
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 3
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 4
                required: [valueCode, value]
            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
                index: 1
                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
                        index: 1
                        elements:
                          value:
                            pattern: {type: Code, value: masked}
                            mustSupport: true
                            choices: [valueCode]
                            index: 3
                          valueCode:
                            type: code
                            pattern: {type: Code, value: masked}
                            mustSupport: true
                            choiceOf: value
                            index: 4
                        required: [valueCode, value]
        ethnicity:
          match: {}
          schema:
            mustSupport: true
            _required: true
            index: 5
            extensions:
              dataAbsentReason:
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                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: [valueCode]
                    index: 8
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 9
                required: [valueCode, value]
            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
                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
                        index: 6
                        elements:
                          value:
                            pattern: {type: Code, value: masked}
                            mustSupport: true
                            choices: [valueCode]
                            index: 8
                          valueCode:
                            type: code
                            pattern: {type: Code, value: masked}
                            mustSupport: true
                            choiceOf: value
                            index: 9
                        required: [valueCode, value]
        birthsex:
          match: {}
          schema: {mustSupport: true, index: 10}
        birthPlace:
          match: {}
          schema: {type: Extension, isModifier: false, mustSupport: true, url: 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace', index: 11}
          min: 0
          max: 1
        genderIdentity:
          match: {}
          schema: {type: Extension, isModifier: false, mustSupport: true, url: 'http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension', index: 12}
          min: 0
        tribalAffiliation:
          match: {}
          schema: {isModifier: false, short: Tribal affiliation and membership of the patient, type: Extension, mustSupport: true, url: 'http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-tribal-affiliation-extension', index: 13}
          min: 0
  communication:
    mustSupport: true
    index: 68
    elements:
      language:
        mustSupport: true
        index: 69
        extensions:
          dataAbsentReason:
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            type: Extension
            mustSupport: true
            index: 70
            elements:
              value:
                pattern: {type: Code, value: masked}
                mustSupport: true
                choices: [valueCode]
                index: 72
              valueCode:
                type: code
                pattern: {type: Code, value: masked}
                mustSupport: true
                choiceOf: value
                index: 73
            required: [valueCode, value]
        elements:
          extension:
            type: Extension
            mustSupport: true
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            index: 70
            slicing:
              slices:
                dataAbsentReason:
                  match: {}
                  schema:
                    type: Extension
                    mustSupport: true
                    url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                    index: 70
                    elements:
                      value:
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choices: [valueCode]
                        index: 72
                      valueCode:
                        type: code
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choiceOf: value
                        index: 73
                    required: [valueCode, value]
  identifier:
    mustSupport: true
    index: 14
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        type: Extension
        index: 15
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 17
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 18
        required: [valueCode, value]
    elements:
      extension:
        type: Extension
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 15
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                index: 15
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 17
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 18
                required: [valueCode, value]
  telecom:
    mustSupport: true
    index: 24
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        type: Extension
        mustSupport: true
        index: 25
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 27
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 28
        required: [valueCode, value]
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 25
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                index: 25
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 27
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 28
                required: [valueCode, value]
    slicing:
      rules: open
      discriminator:
      - {path: system, type: value}
      min: 1
      slices:
        phone:
          match: {system: phone}
          schema:
            mustSupport: true
            index: 29
            elements:
              system:
                pattern: {type: Code, value: phone}
                mustSupport: true
                index: 30
            required: [system]
        email:
          match: {system: email}
          schema:
            mustSupport: true
            index: 31
            elements:
              system:
                pattern: {type: Code, value: email}
                mustSupport: true
                index: 32
            required: [system]
  gender:
    mustSupport: true
    index: 33
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        type: Extension
        mustSupport: true
        index: 34
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 36
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 37
        required: [valueCode, value]
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 34
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                index: 34
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 36
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 37
                required: [valueCode, value]
  contact:
    mustSupport: true
    index: 51
    elements:
      relationship: {mustSupport: true, index: 52}
      name:
        mustSupport: true
        index: 53
        extensions:
          dataAbsentReason:
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            type: Extension
            mustSupport: true
            index: 54
            elements:
              value:
                pattern: {type: Code, value: masked}
                mustSupport: true
                choices: [valueCode]
                index: 56
              valueCode:
                type: code
                pattern: {type: Code, value: masked}
                mustSupport: true
                choiceOf: value
                index: 57
            required: [valueCode, value]
        elements:
          extension:
            type: Extension
            mustSupport: true
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            index: 54
            slicing:
              slices:
                dataAbsentReason:
                  match: {}
                  schema:
                    type: Extension
                    mustSupport: true
                    url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                    index: 54
                    elements:
                      value:
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choices: [valueCode]
                        index: 56
                      valueCode:
                        type: code
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choiceOf: value
                        index: 57
                    required: [valueCode, value]
      telecom:
        mustSupport: true
        index: 58
        extensions:
          dataAbsentReason:
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            type: Extension
            mustSupport: true
            index: 59
            elements:
              value:
                pattern: {type: Code, value: masked}
                mustSupport: true
                choices: [valueCode]
                index: 61
              valueCode:
                type: code
                pattern: {type: Code, value: masked}
                mustSupport: true
                choiceOf: value
                index: 62
            required: [valueCode, value]
        elements:
          extension:
            type: Extension
            mustSupport: true
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            index: 59
            slicing:
              slices:
                dataAbsentReason:
                  match: {}
                  schema:
                    type: Extension
                    mustSupport: true
                    url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                    index: 59
                    elements:
                      value:
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choices: [valueCode]
                        index: 61
                      valueCode:
                        type: code
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choiceOf: value
                        index: 62
                    required: [valueCode, value]
      address:
        mustSupport: true
        index: 63
        extensions:
          dataAbsentReason:
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            type: Extension
            mustSupport: true
            index: 64
            elements:
              value:
                pattern: {type: Code, value: masked}
                mustSupport: true
                choices: [valueCode]
                index: 66
              valueCode:
                type: code
                pattern: {type: Code, value: masked}
                mustSupport: true
                choiceOf: value
                index: 67
            required: [valueCode, value]
        elements:
          extension:
            type: Extension
            mustSupport: true
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            index: 64
            slicing:
              slices:
                dataAbsentReason:
                  match: {}
                  schema:
                    type: Extension
                    mustSupport: true
                    url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                    index: 64
                    elements:
                      value:
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choices: [valueCode]
                        index: 66
                      valueCode:
                        type: code
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choiceOf: value
                        index: 67
                    required: [valueCode, value]
    required: [relationship, name, address, telecom]
package_version: 2.1.1
extensions:
  race:
    url: null
    mustSupport: true
    _required: true
    index: 0
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        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: 1
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 3
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 4
        required: [valueCode, value]
    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
        index: 1
        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
                index: 1
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 3
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 4
                required: [valueCode, value]
  ethnicity:
    url: null
    mustSupport: true
    _required: true
    index: 5
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        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: [valueCode]
            index: 8
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 9
        required: [valueCode, value]
    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
        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
                index: 6
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 8
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 9
                required: [valueCode, value]
  birthsex: {url: null, mustSupport: true, index: 10}
  birthPlace: {url: 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace', min: 0, max: 1, type: Extension, isModifier: false, mustSupport: true, index: 11}
  genderIdentity: {url: 'http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension', min: 0, type: Extension, isModifier: false, mustSupport: true, index: 12}
  tribalAffiliation: {url: 'http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-tribal-affiliation-extension', min: 0, isModifier: false, short: Tribal affiliation and membership of the patient, type: Extension, mustSupport: true, index: 13}
class: profile
kind: resource
url: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-patient
base: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
version: 2.1.1
required: [name, extension, address, identifier, birthDate, communication, telecom, deceased]