description: This profile defines a patient administration details structure that includes core localisation concepts for use in an Australian context.
package_name: hl7.fhir.au.base
derivation: constraint
name: AUBasePatient
type: Patient
elements:
  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: 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace', index: 1}
          min: 0
          max: 1
        indigenousStatus:
          match: {url: null}
          schema: {type: Extension, short: Patient Indigenous Status, url: 'http://hl7.org.au/fhir/StructureDefinition/indigenous-status', index: 2}
          min: 0
          max: 1
        closingTheGapRegistration:
          match: {url: null}
          schema: {type: Extension, short: Patient Closing the Gap Program Eligibility Indication, url: 'http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration', index: 3}
          min: 0
          max: 1
        mothersMaidenName:
          match: {url: null}
          schema: {type: Extension, short: Patient Mother's Maiden Name, url: 'http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName', index: 4}
          min: 0
          max: 1
  identifier:
    index: 5
    slicing:
      rules: open
      discriminator:
      - {path: type, type: pattern}
      - {path: system, type: value}
      min: null
      slices:
        ihiNumber:
          match:
            type:
              coding:
              - {code: NI, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
            system: http://ns.electronichealth.net.au/id/hi/ihi/1.0
          schema:
            short: National Individual Healthcare Identifier (IHI)
            constraint:
              inv-ihi-value-0: {human: IHI shall be an exactly 16 digit number, severity: error, expression: 'value.matches(''^([0-9]{16})$'')'}
              inv-ihi-value-1: {human: IHI prefix is 800360, severity: error, expression: value.startsWith('800360')}
              inv-ihi-value-2: {human: IHI shall pass the Luhn algorithm check, severity: error, expression: '(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)'}
            index: 6
            extensions:
              ihiStatus: {url: 'http://hl7.org.au/fhir/StructureDefinition/ihi-status', min: 0, max: 1, type: Extension, short: Individual Healthcare Identifier (IHI) Number Status, index: 8}
              ihiRecordStatus: {url: 'http://hl7.org.au/fhir/StructureDefinition/ihi-record-status', min: 0, max: 1, type: Extension, short: Individual Healthcare Identifier (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: Individual Healthcare Identifier (IHI) Number Status, url: 'http://hl7.org.au/fhir/StructureDefinition/ihi-status', index: 8}
                      min: 0
                      max: 1
                    ihiRecordStatus:
                      match: {url: null}
                      schema: {type: Extension, short: Individual Healthcare Identifier (IHI) Number Record Status, url: 'http://hl7.org.au/fhir/StructureDefinition/ihi-record-status', index: 9}
                      min: 0
                      max: 1
              type:
                short: Coded identifier type for IHI
                binding: {strength: required, valueSet: 'http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203'}
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: NI, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
                index: 10
                elements:
                  text:
                    pattern: {type: String, value: IHI}
                    index: 11
              system:
                short: Namespace for IHI
                pattern: {type: Uri, value: 'http://ns.electronichealth.net.au/id/hi/ihi/1.0'}
                index: 12
              value: {short: IHI number, maxLength: 16, index: 13}
            required: [value, system]
        medicareNumber:
          match:
            type:
              coding:
              - {code: MC, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
            system: http://ns.electronichealth.net.au/id/medicare-number
          schema:
            short: Medicare Number
            index: 14
            elements:
              type:
                short: Coded identifier type for Medicare number
                binding: {strength: required, valueSet: 'http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203'}
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: MC, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
                index: 15
                elements:
                  text:
                    pattern: {type: String, value: Medicare Number}
                    index: 16
              system:
                short: Namespace for Medicare number
                pattern: {type: Uri, value: 'http://ns.electronichealth.net.au/id/medicare-number'}
                index: 17
              value: {short: Medicare number including optional individual reference number, maxLength: 11, index: 18}
              period:
                short: Medicare number validity period
                index: 19
                elements:
                  end: {short: Medicare number expiry date, index: 20}
                required: [end]
            required: [value, period, system]
        dvaNumber:
          match: {type: null, system: 'http://ns.electronichealth.net.au/id/dva'}
          schema:
            short: Department of Veterans' Affairs (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: 21
            elements:
              type:
                short: Coded identifier type for DVA number
                binding: {strength: required, valueSet: 'http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203'}
                index: 22
                elements:
                  text: {index: 23}
              system:
                short: Namespace for DVA number
                pattern: {type: Uri, value: 'http://ns.electronichealth.net.au/id/dva'}
                index: 24
              value: {short: DVA number, maxLength: 9, index: 25}
            required: [value, system]
        healthcareCard:
          match:
            type:
              coding:
              - {code: HC, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
            system: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
          schema:
            short: Health Care Card Number
            index: 26
            elements:
              type:
                short: Coded identifier type for Health Care Card number
                binding: {strength: required, valueSet: 'http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203'}
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: HC, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
                index: 27
                elements:
                  text:
                    pattern: {type: String, value: Health Care Card Number}
                    index: 28
              system:
                short: Namespace for Centrelink Customer Reference Number (CRN)
                pattern: {type: Uri, value: 'http://ns.electronichealth.net.au/id/centrelink-customer-reference-number'}
                index: 29
              value: {short: Centrelink CRN, maxLength: 10, index: 30}
            required: [value, type, system]
        pensionerConcessionCard:
          match:
            type:
              coding:
              - {code: PEN, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
            system: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
          schema:
            short: Pensioner Concession Card Number
            index: 31
            elements:
              type:
                short: Coded identifier type for Pensioner Concession Card number
                binding: {strength: required, valueSet: 'http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203'}
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: PEN, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
                index: 32
                elements:
                  text:
                    pattern: {type: String, value: Pensioner Concession Card Number}
                    index: 33
              system:
                short: Namespace for Centrelink Customer Reference Number (CRN)
                pattern: {type: Uri, value: 'http://ns.electronichealth.net.au/id/centrelink-customer-reference-number'}
                index: 34
              value: {short: Centrelink CRN, maxLength: 10, index: 35}
            required: [value, type, system]
        commonwealthSeniorsHealthCard:
          match:
            type:
              coding:
              - {code: SEN, system: 'http://terminology.hl7.org.au/CodeSystem/v2-0203'}
            system: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
          schema:
            short: Commonwealth Seniors Health Card Number
            index: 36
            elements:
              type:
                short: Coded identifier type for Commonwealth Seniors Health Card number
                binding: {strength: required, valueSet: 'http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203'}
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: SEN, system: 'http://terminology.hl7.org.au/CodeSystem/v2-0203'}
                index: 37
                elements:
                  text:
                    pattern: {type: String, value: Commonwealth Seniors Health Card}
                    index: 38
              system:
                short: Namespace for Centrelink Customer Reference Number (CRN)
                pattern: {type: Uri, value: 'http://ns.electronichealth.net.au/id/centrelink-customer-reference-number'}
                index: 39
              value: {short: Centrelink CRN, maxLength: 10, index: 40}
            required: [value, type, system]
        medicalRecordNumber:
          match:
            type:
              coding:
              - {code: MR, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
            system: null
          schema:
            short: Medical Record Number (MRN)
            index: 41
            elements:
              type:
                short: Coded identifier type for MRN
                binding: {strength: required, valueSet: 'http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203'}
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: MR, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
                index: 42
                elements:
                  text:
                    pattern: {type: String, value: Medical Record Number}
                    index: 43
              system: {short: Medical record number system namespace, index: 44}
              value: {short: Medical record number, index: 45}
              assigner: {short: Medical record number assigning entity, index: 46}
            required: [assigner, value, type, system]
        insurerNumber:
          match:
            type:
              coding:
              - {code: MB, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
            system: null
          schema:
            short: Private Health Insurance Member Number
            index: 47
            elements:
              type:
                short: Coded identifier type for private health insurance member number
                binding: {strength: required, valueSet: 'http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203'}
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: MB, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
                index: 48
                elements:
                  text:
                    pattern: {type: String, value: Private Health Insurance Member Number}
                    index: 49
              value: {short: Private health insurance member number, index: 50}
              assigner:
                short: Private health insurer
                index: 51
                elements:
                  display: {index: 52}
                required: [display]
            required: [assigner, value, type]
  birthDate:
    short: Date of birth extended for time and accuracy indicator
    index: 53
    extensions:
      accuracyIndicator: {url: 'http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator', min: 0, max: 1, type: Extension, short: Birth Date Accuracy Indicator, index: 55}
      birthTime: {url: 'http://hl7.org/fhir/StructureDefinition/patient-birthTime', min: 0, max: 1, type: Extension, short: Birth Time, index: 56}
    elements:
      extension:
        index: 54
        slicing:
          rules: open
          discriminator:
          - {path: url, type: value}
          min: null
          slices:
            accuracyIndicator:
              match: {url: null}
              schema: {type: Extension, short: Birth Date Accuracy Indicator, url: 'http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator', index: 55}
              min: 0
              max: 1
            birthTime:
              match: {url: null}
              schema: {type: Extension, short: Birth Time, url: 'http://hl7.org/fhir/StructureDefinition/patient-birthTime', index: 56}
              min: 0
              max: 1
  deceased:
    short: Deceased Date Time
    choices: [deceasedDateTime]
    index: 63
    slicing:
      slices:
        deceasedDateTime:
          match: {}
          schema:
            short: Deceased Date Time
            choices: [deceasedDateTime]
            index: 63
  deceasedBoolean:
    type: boolean
    short: Deceased Indicator
    choiceOf: deceased
    index: 61
    slicing:
      slices:
        deceasedBoolean:
          match: {}
          schema: {type: boolean, short: Deceased Indicator, choiceOf: deceased, index: 61}
  deceasedDateTime:
    type: dateTime
    short: Deceased Date Time
    choiceOf: deceased
    index: 64
    slicing:
      slices:
        deceasedDateTime:
          match: {}
          schema: {type: dateTime, short: Deceased Date Time, choiceOf: deceased, index: 64}
  deceased[x]:
    extensions:
      accuracyIndicator: {url: 'http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator', min: 0, max: 1, type: Extension, short: Deceased Date Accuracy Indicator, index: 66}
    elements:
      extension:
        index: 65
        slicing:
          rules: open
          discriminator:
          - {path: url, type: value}
          min: 0
          max: 1
          slices:
            accuracyIndicator:
              match: {url: null}
              schema: {type: Extension, short: Deceased Date Accuracy Indicator, url: 'http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator', index: 66}
              min: 0
              max: 1
  communication:
    index: 67
    elements:
      language:
        binding: {strength: extensible, valueSet: 'https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2'}
        index: 68
package_version: 1.0.1
extensions:
  birthPlace: {url: 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace', min: 0, max: 1, type: Extension, short: Patient Birth Place, index: 1}
  indigenousStatus: {url: 'http://hl7.org.au/fhir/StructureDefinition/indigenous-status', min: 0, max: 1, type: Extension, short: Patient Indigenous Status, index: 2}
  closingTheGapRegistration: {url: 'http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration', min: 0, max: 1, type: Extension, short: Patient Closing the Gap Program Eligibility Indication, index: 3}
  mothersMaidenName: {url: 'http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName', 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: 2.0.0