PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.us.central@cancer-registry-reporting-0.1.0
    http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/us-ph-patient
description: This Patient profile represents a US Public Health Patient.\n\nIt is based on the **US Core Patient** profile with further restrictions to allow masking of some data elements and the addition of the patient-genderIdentity extension.\n\nFor ONC’s USCDI requirements, it 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.central
derivation: constraint
name: USPublicHealthPatient
type: Patient
elements:
  address:
    mustSupport: true
    index: 37
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        type: Extension
        mustSupport: true
        index: 38
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 40
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 41
        required: [valueCode, value]
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 38
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                index: 38
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 40
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 41
                required: [valueCode, value]
      district: {short: County, mustSupport: true, index: 42}
  name:
    index: 11
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        type: Extension
        mustSupport: true
        index: 12
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 14
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 15
        required: [valueCode, value]
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 12
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                index: 12
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 14
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 15
                required: [valueCode, value]
  birthDate:
    mustSupport: true
    index: 30
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        type: Extension
        mustSupport: true
        index: 31
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 33
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 34
        required: [valueCode, value]
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 31
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                index: 31
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 33
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 34
                required: [valueCode, value]
  deceased:
    choices: []
    index: 36
  extension:
    mustSupport: true
    index: 0
    slicing:
      slices:
        race:
          match: {}
          schema: {mustSupport: true, index: 0}
        ethnicity:
          match: {}
          schema: {mustSupport: true, index: 1}
        birthsex:
          match: {}
          schema: {mustSupport: true, index: 2}
        birthPlace:
          match: {}
          schema: {type: Extension, isModifier: false, mustSupport: true, url: 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace', index: 3}
          min: 0
          max: 1
        genderIdentity:
          match: {}
          schema: {type: Extension, isModifier: false, mustSupport: true, url: 'http://hl7.org/fhir/StructureDefinition/patient-genderIdentity', index: 4}
          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/central-cancer-registry-reporting/StructureDefinition/us-ph-tribal-affiliation-extension', index: 5}
          min: 0
  communication:
    mustSupport: true
    index: 60
    elements:
      language:
        mustSupport: true
        index: 61
        extensions:
          dataAbsentReason:
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            type: Extension
            mustSupport: true
            index: 62
            elements:
              value:
                pattern: {type: Code, value: masked}
                mustSupport: true
                choices: [valueCode]
                index: 64
              valueCode:
                type: code
                pattern: {type: Code, value: masked}
                mustSupport: true
                choiceOf: value
                index: 65
            required: [valueCode, value]
        elements:
          extension:
            type: Extension
            mustSupport: true
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            index: 62
            slicing:
              slices:
                dataAbsentReason:
                  match: {}
                  schema:
                    type: Extension
                    mustSupport: true
                    url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                    index: 62
                    elements:
                      value:
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choices: [valueCode]
                        index: 64
                      valueCode:
                        type: code
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choiceOf: value
                        index: 65
                    required: [valueCode, value]
  identifier:
    mustSupport: true
    index: 6
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        type: Extension
        index: 7
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 9
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 10
        required: [valueCode, value]
    elements:
      extension:
        type: Extension
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 7
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                index: 7
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 9
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 10
                required: [valueCode, value]
  telecom:
    mustSupport: true
    index: 16
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        type: Extension
        mustSupport: true
        index: 17
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 19
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 20
        required: [valueCode, value]
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 17
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                index: 17
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 19
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 20
                required: [valueCode, value]
    slicing:
      rules: open
      discriminator:
      - {path: system, type: value}
      min: 1
      slices:
        phone:
          match: {system: phone}
          schema:
            mustSupport: true
            index: 21
            elements:
              system:
                pattern: {type: Code, value: phone}
                mustSupport: true
                index: 22
            required: [system]
        email:
          match: {system: email}
          schema:
            mustSupport: true
            index: 23
            elements:
              system:
                pattern: {type: Code, value: email}
                mustSupport: true
                index: 24
            required: [system]
  gender:
    mustSupport: true
    index: 25
    extensions:
      dataAbsentReason:
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        type: Extension
        mustSupport: true
        index: 26
        elements:
          value:
            pattern: {type: Code, value: masked}
            mustSupport: true
            choices: [valueCode]
            index: 28
          valueCode:
            type: code
            pattern: {type: Code, value: masked}
            mustSupport: true
            choiceOf: value
            index: 29
        required: [valueCode, value]
    elements:
      extension:
        type: Extension
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 26
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema:
                type: Extension
                mustSupport: true
                url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                index: 26
                elements:
                  value:
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choices: [valueCode]
                    index: 28
                  valueCode:
                    type: code
                    pattern: {type: Code, value: masked}
                    mustSupport: true
                    choiceOf: value
                    index: 29
                required: [valueCode, value]
  contact:
    mustSupport: true
    index: 43
    elements:
      relationship: {mustSupport: true, index: 44}
      name:
        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]
      telecom:
        mustSupport: true
        index: 50
        extensions:
          dataAbsentReason:
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            type: Extension
            mustSupport: true
            index: 51
            elements:
              value:
                pattern: {type: Code, value: masked}
                mustSupport: true
                choices: [valueCode]
                index: 53
              valueCode:
                type: code
                pattern: {type: Code, value: masked}
                mustSupport: true
                choiceOf: value
                index: 54
            required: [valueCode, value]
        elements:
          extension:
            type: Extension
            mustSupport: true
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            index: 51
            slicing:
              slices:
                dataAbsentReason:
                  match: {}
                  schema:
                    type: Extension
                    mustSupport: true
                    url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                    index: 51
                    elements:
                      value:
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choices: [valueCode]
                        index: 53
                      valueCode:
                        type: code
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choiceOf: value
                        index: 54
                    required: [valueCode, value]
      address:
        mustSupport: true
        index: 55
        extensions:
          dataAbsentReason:
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            type: Extension
            mustSupport: true
            index: 56
            elements:
              value:
                pattern: {type: Code, value: masked}
                mustSupport: true
                choices: [valueCode]
                index: 58
              valueCode:
                type: code
                pattern: {type: Code, value: masked}
                mustSupport: true
                choiceOf: value
                index: 59
            required: [valueCode, value]
        elements:
          extension:
            type: Extension
            mustSupport: true
            url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
            index: 56
            slicing:
              slices:
                dataAbsentReason:
                  match: {}
                  schema:
                    type: Extension
                    mustSupport: true
                    url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
                    index: 56
                    elements:
                      value:
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choices: [valueCode]
                        index: 58
                      valueCode:
                        type: code
                        pattern: {type: Code, value: masked}
                        mustSupport: true
                        choiceOf: value
                        index: 59
                    required: [valueCode, value]
    required: [relationship]
package_version: cancer-registry-reporting-0.1.0
extensions:
  race: {url: null, mustSupport: true, index: 0}
  ethnicity: {url: null, mustSupport: true, index: 1}
  birthsex: {url: null, mustSupport: true, index: 2}
  birthPlace: {url: 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace', min: 0, max: 1, type: Extension, isModifier: false, mustSupport: true, index: 3}
  genderIdentity: {url: 'http://hl7.org/fhir/StructureDefinition/patient-genderIdentity', min: 0, type: Extension, isModifier: false, mustSupport: true, index: 4}
  tribalAffiliation: {url: 'http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/us-ph-tribal-affiliation-extension', min: 0, isModifier: false, short: Tribal affiliation and membership of the patient, type: Extension, mustSupport: true, index: 5}
class: profile
kind: resource
url: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/us-ph-patient
base: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
version: 0.1.0
required: [name, address, identifier, birthDate, telecom]