description: Australian realm Patient profile
package_name: hl7.fhir.au.base
derivation: constraint
name: AUBasePatient
type: Patient
elements:
  deceasedDateTime:
    type: dateTime
    short: Deceased Date Time
    choiceOf: deceased
    index: 86
    slicing:
      slices:
        deceasedDateTime:
          match: {}
          schema: {type: dateTime, short: Deceased Date Time, choiceOf: deceased, index: 86}
  managingOrganization:
    type: Reference
    short: Patient managing organisation
    refers: ['http://hl7.org.au/fhir/StructureDefinition/au-organisation']
    index: 93
  deceasedBoolean:
    type: boolean
    short: Deceased Indicator
    choiceOf: deceased
    index: 83
    slicing:
      slices:
        deceasedBoolean:
          match: {}
          schema: {type: boolean, short: Deceased Indicator, choiceOf: deceased, index: 83}
  birthDate:
    short: Date of birth extended for time and accuracy indicator
    index: 75
    extensions:
      accuracyIndicator: {url: h, min: 0, max: 1, type: Extension, short: Birth Date Accuracy Indicator, index: 77}
      birthTime: {url: h, min: 0, max: 1, type: Extension, short: Birth Time, index: 78}
    elements:
      extension:
        index: 76
        slicing:
          rules: open
          discriminator:
          - {path: url, type: value}
          min: null
          slices:
            accuracyIndicator:
              match: {url: null}
              schema: {type: Extension, short: Birth Date Accuracy Indicator, url: h, index: 77}
              min: 0
              max: 1
            birthTime:
              match: {url: null}
              schema: {type: Extension, short: Birth Time, url: h, index: 78}
              min: 0
              max: 1
  deceased:
    short: Deceased Date Time
    choices: [deceasedDateTime]
    index: 85
    slicing:
      slices:
        deceasedDateTime:
          match: {}
          schema:
            short: Deceased Date Time
            choices: [deceasedDateTime]
            index: 85
  extension:
    index: 0
    slicing:
      rules: open
      discriminator:
      - {path: url, type: value}
      min: null
      slices:
        birthPlace:
          match: {url: null}
          schema: {type: Extension, short: Patient birth place, url: h, index: 1}
          min: 0
          max: 1
        indigenousStatus:
          match: {url: null}
          schema: {type: Extension, short: Patient indigenous status, url: h, index: 2}
          min: 0
          max: 1
        closeTheGapRegistration:
          match: {url: null}
          schema: {type: Extension, short: Patient Close the Gap registration, url: h, index: 3}
          min: 0
          max: 1
        mothersMaidenName:
          match: {url: null}
          schema: {type: Extension, short: Patient mother's maiden name, url: h, index: 4}
          min: 0
          max: 1
  deceased[x]:
    extensions:
      accuracyIndicator: {url: h, min: 0, max: 1, type: Extension, short: Deceased Date Accuracy Indicator, index: 88}
    elements:
      extension:
        index: 87
        slicing:
          rules: open
          discriminator:
          - {path: url, type: value}
          min: null
          slices:
            accuracyIndicator:
              match: {url: null}
              schema: {type: Extension, short: Deceased Date Accuracy Indicator, url: h, index: 88}
              min: 0
              max: 1
  link:
    elements:
      other:
        type: Reference
        refers: ['http://hl7.org.au/fhir/StructureDefinition/au-patient', 'http://hl7.org.au/fhir/StructureDefinition/au-relatedperson']
        index: 94
  communication:
    index: 90
    elements:
      language: {index: 91}
  identifier:
    index: 5
    slicing:
      rules: open
      discriminator:
      - {path: system, type: value}
      - {path: type, type: value}
      min: null
      slices:
        ihiNumber:
          match: {system: 'http://ns.electronichealth.net.au/id/hi/ihi/1.0', type: null}
          schema:
            short: National Individual Health Identifier
            index: 6
            extensions:
              ihiStatus: {url: h, min: 0, max: 1, type: Extension, short: IHI Number Status, index: 8}
              ihiRecordStatus: {url: h, min: 0, max: 1, type: Extension, short: IHI Number Record Status, index: 9}
            elements:
              extension:
                index: 7
                slicing:
                  rules: open
                  discriminator:
                  - {path: url, type: value}
                  min: null
                  slices:
                    ihiStatus:
                      match: {url: null}
                      schema: {type: Extension, short: IHI Number Status, url: h, index: 8}
                      min: 0
                      max: 1
                    ihiRecordStatus:
                      match: {url: null}
                      schema: {type: Extension, short: IHI Number Record Status, url: h, index: 9}
                      min: 0
                      max: 1
              type:
                short: Coded identifier type for IHI
                index: 10
                elements:
                  coding:
                    index: 11
                    elements:
                      system:
                        short: Required system
                        pattern: {type: Uri, value: 'http://hl7.org/fhir/v2/0203'}
                        index: 12
                      code:
                        pattern: {type: Code, value: NI}
                        index: 13
                    required: [system, code]
                  text:
                    pattern: {type: String, value: IHI}
                    index: 14
                required: [text]
              system:
                short: national namespace for ihi
                pattern: {type: Uri, value: 'http://ns.electronichealth.net.au/id/hi/ihi/1.0'}
                index: 15
              value:
                short: Individual Health Identifier number
                maxLength: 16
                constraint:
                  inv-ihi-0: {human: IHI shall be an exactly 16 digit number, severity: error, expression: 'matches(''^([0-9]{16})$'')'}
                  inv-ihi-1: {human: IHI prefix is 800360, severity: error, expression: startsWith('800360')}
                  inv-ihi-2: {human: IHI shall pass the Luhn algorithm check, severity: error, expression: '(((select(substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(1,1).toInteger())+(select(substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(3,1).toInteger())+(select(substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(5,1).toInteger())+(select(substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(7,1).toInteger())+(select(substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(9,1).toInteger())+(select(substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(11,1).toInteger())+(select(substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(13,1).toInteger())+(select(substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(15,1).toInteger()))mod 10=0)'}
                index: 16
            required: [value, type, system]
        medicareNumber:
          match: {system: 'http://ns.electronichealth.net.au/id/medicare-number', type: null}
          schema:
            short: Medicare Number
            index: 17
            elements:
              type:
                index: 18
                elements:
                  coding:
                    index: 19
                    elements:
                      system:
                        pattern: {type: Uri, value: 'http://hl7.org/fhir/v2/0203'}
                        index: 20
                      code:
                        pattern: {type: Code, value: MC}
                        index: 21
                    required: [system, code]
                  text:
                    pattern: {type: String, value: Medicare Number}
                    index: 22
                required: [text]
              system:
                short: national namespace for medicare
                pattern: {type: Uri, value: 'http://ns.electronichealth.net.au/id/medicare-number'}
                index: 23
              value: {short: Medicare Number value including optional individual reference number, maxLength: 11, index: 24}
              period:
                short: Medicare validity period
                index: 25
                elements:
                  end: {short: Medicare Expiry Date, index: 26}
                required: [end]
            required: [value, type, period, system]
        dvaNumber:
          match: {system: 'http://ns.electronichealth.net.au/id/dva', type: null}
          schema:
            short: DVA Number
            constraint:
              inv-dva-number-unspecified: {human: DVA Number identifier type text must be 'DVA Number' when colour is not specified, severity: error, expression: type.coding.empty() implies type.text = 'DVA Number'}
              inv-dva-number-gold: {human: DVA Number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG, severity: error, expression: type.coding.code='DVG' implies type.text = 'DVA Number (Gold)'}
              inv-dva-number-white: {human: DVA Number identifier type text must be 'DVA Number (White)' when colour coding is DVW, severity: error, expression: type.coding.code='DVW' implies type.text = 'DVA Number (White)'}
              inv-dva-number-orange: {human: DVA Number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO, severity: error, expression: type.coding.code='DVO' implies type.text = 'DVA Number (Orange)'}
              inv-dva-number-lilac: {human: DVA Number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL, severity: error, expression: type.coding.code='DVL' implies type.text = 'DVA Number (Lilac)'}
              inv-dva-number-text: {human: 'DVA Number identifier type text must be one of ''DVA Number'', ''DVA Number (Gold)'',  ''DVA Number (White), ''DVA Number (Orange), ''DVA Number (Lilac)''', severity: error, expression: type.text = 'DVA Number' or type.text = 'DVA Number (Gold)' or type.text = 'DVA Number (White)' or type.text = 'DVA Number (Orange)' or type.text = 'DVA Number (Lilac)'}
            index: 27
            elements:
              type:
                index: 28
                elements:
                  coding:
                    constraint:
                      inv-dva-number-coding: {human: 'DVA colour coding must be DVL, DVW, DVO or DVG', severity: error, expression: code='DVL' or code='DVW' or code='DVO' or code='DVG'}
                    index: 29
                  text: {index: 30}
                required: [text]
              system:
                short: DVA number identifier system
                pattern: {type: Uri, value: 'http://ns.electronichealth.net.au/id/dva'}
                index: 31
              value: {short: DVA number value, maxLength: 9, index: 32}
            required: [value, type, system]
        healthcareCard:
          match: {system: 'http://ns.electronichealth.net.au/id/centrelink-customer-reference-number', type: null}
          schema:
            short: Health Care Card Identifier
            index: 33
            elements:
              type:
                short: Health Care Card Identifier Type
                index: 34
                elements:
                  coding:
                    index: 35
                    elements:
                      system:
                        pattern: {type: Uri, value: 'http://hl7.org/fhir/v2/0203'}
                        index: 36
                      code:
                        pattern: {type: Code, value: HC}
                        index: 37
                    required: [system, code]
                  text:
                    pattern: {type: String, value: Health Care Card Number}
                    index: 38
                required: [text]
              system:
                short: namespace for Centrelink CRN identifiers
                pattern: {type: Uri, value: 'http://ns.electronichealth.net.au/id/centrelink-customer-reference-number'}
                index: 39
              value: {short: Centrelink Customer Reference Number (CRN), maxLength: 10, index: 40}
            required: [value, type, system]
        pensionerConcessionCard:
          match: {system: 'http://ns.electronichealth.net.au/id/centrelink-customer-reference-number', type: null}
          schema:
            short: Pensioner Concession Card Identifier
            index: 41
            elements:
              type:
                short: Pensioner Concession Card Identifier Type
                index: 42
                elements:
                  coding:
                    index: 43
                    elements:
                      system:
                        pattern: {type: Uri, value: 'http://hl7.org/fhir/v2/0203'}
                        index: 44
                      code:
                        pattern: {type: Code, value: PEN}
                        index: 45
                    required: [system, code]
                  text:
                    pattern: {type: String, value: Pensioner Concession Card Number}
                    index: 46
                required: [text]
              system:
                short: namespace for Centrelink CRN identifiers
                pattern: {type: Uri, value: 'http://ns.electronichealth.net.au/id/centrelink-customer-reference-number'}
                index: 47
              value: {short: Centrelink Customer Reference Number (CRN), maxLength: 10, index: 48}
            required: [value, type, system]
        commonwealthSeniorsHealthCard:
          match: {system: 'http://ns.electronichealth.net.au/id/centrelink-customer-reference-number', type: null}
          schema:
            short: Commonwealth Seniors Health Card Identifier
            index: 49
            elements:
              type:
                short: Commonwealth Seniors Health Card Identifier Type
                index: 50
                elements:
                  coding:
                    index: 51
                    elements:
                      system:
                        pattern: {type: Uri, value: 'http://hl7.org.au/fhir/v2/0203'}
                        index: 52
                      code:
                        pattern: {type: Code, value: SEN}
                        index: 53
                    required: [system, code]
                  text:
                    pattern: {type: String, value: Commonwealth Seniors Health Card}
                    index: 54
                required: [text]
              system:
                short: namespace for Centrelink CRN identifiers
                pattern: {type: Uri, value: 'http://ns.electronichealth.net.au/id/centrelink-customer-reference-number'}
                index: 55
              value: {short: Centrelink Customer Reference Number (CRN), maxLength: 10, index: 56}
            required: [value, type, system]
        medicalRecordNumber:
          match: {system: null, type: null}
          schema:
            short: Medical Record Number
            index: 57
            elements:
              type:
                index: 58
                elements:
                  coding:
                    index: 59
                    elements:
                      system:
                        pattern: {type: Uri, value: 'http://hl7.org/fhir/v2/0203'}
                        index: 60
                      code:
                        pattern: {type: Code, value: MR}
                        index: 61
                    required: [system, code]
                  text:
                    pattern: {type: String, value: Medical Record Number}
                    index: 62
                required: [coding, text]
              system: {short: Medical record number system url, index: 63}
              value: {short: Medical record number value, index: 64}
              assigner: {short: Medical record number assigning entity, index: 65}
            required: [assigner, value, type, system]
        insurerNumber:
          match: {system: null, type: null}
          schema:
            short: Private Health Insurance Member Number
            index: 66
            elements:
              type:
                index: 67
                elements:
                  coding:
                    index: 68
                    elements:
                      system:
                        pattern: {type: Uri, value: 'http://hl7.org/fhir/v2/0203'}
                        index: 69
                      code:
                        pattern: {type: Code, value: MB}
                        index: 70
                    required: [system, code]
                  text:
                    pattern: {type: String, value: Private Health Insurance Member Number}
                    index: 71
                required: [coding, text]
              value: {short: Private health insurer member number, index: 72}
              assigner:
                index: 73
                elements:
                  display: {index: 74}
                required: [display]
            required: [assigner, value, type]
  generalPractitioner:
    type: Reference
    short: Usual GP practice or practitioner
    refers: ['http://hl7.org.au/fhir/StructureDefinition/au-organisation', 'http://hl7.org.au/fhir/StructureDefinition/au-practitioner']
    index: 92
  contact:
    elements:
      organization:
        type: Reference
        refers: ['http://hl7.org.au/fhir/StructureDefinition/au-organisation']
        index: 89
package_version: 0.9.3
extensions:
  birthPlace: {url: h, min: 0, max: 1, type: Extension, short: Patient birth place, index: 1}
  indigenousStatus: {url: h, min: 0, max: 1, type: Extension, short: Patient indigenous status, index: 2}
  closeTheGapRegistration: {url: h, min: 0, max: 1, type: Extension, short: Patient Close the Gap registration, index: 3}
  mothersMaidenName: {url: h, min: 0, max: 1, type: Extension, short: Patient mother's maiden name, index: 4}
class: profile
kind: resource
url: http://hl7.org.au/fhir/StructureDefinition/au-patient
base: http://hl7.org/fhir/StructureDefinition/Patient
version: '0.1'