Magentus Practice Management FHIR Implementation Guide
1.2.16 - ci-build

Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.16) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: Genie Patient

Official URL: http://fhir.geniesolutions.io/StructureDefinition/gs-patient | Version: 1.2.16
Draft as of 2024-08-15 | Computable Name: GSPatient

Genie Patient core profile

Usage:

- Use this Resource Profile: EBookings Theatre List
- Refer to this Resource Profile: EBookings Anaesthetic Request, EBookings Appointment Base, EBookings Appointment Response, EBookings ChargeItem... Show 16 more, EBookings Consent, EBookings Encounter, EBookings Prosthesis Device, EBookings ServiceRequest, EOrders Communication Request Patient, EOrders Communication Request Provider, EOrders Consent Withdrawl, EOrders Diagnostic Request Base, EOrders Diagnostic Request, EOrders Encounter, EOrders Task Fulfillment Request Base, Genie ChargeItem Base, Genie Coverage, Referral Request, Referral Fulfilment Task and Diagnostic Report Base
- Examples for this Resource Profile: Patient/1078d551-7be2-49f7-a122-c230b8757f2f and Patient/ReferralPatient

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from AUBasePatient

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  |  | AUBasePatient |
id | S | 0..1 | id | Logical id of this artifact
Slices for identifier |  | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
identifier:ihi | S | 0..1 | AUIHI | Individual Healthcare Identifier (IHI)
identifier:medicare | S | 0..1 | AUMedicareCardNumber | Medicare Card Number
identifier:dva |  | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
identifier:insurancemember | S | 0..1 | AUInsuranceMemberNumber | Insurance Member Number
type |  |  |  |
coding |  | 1..1 | Coding | Code defined by a terminology system
identifier:mrn | S | 0..1 | AUMedicalRecordNumber | Medical Record Number (MRN)
active | S | 1..1 | boolean | Whether this patient's record is in active use
Slices for name |  | 1..* | HumanName | A name associated with the patient Slice: Unordered, Closed by value:use
name:official | S | 1..1 | HumanName | A name associated with the patient
use |  | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official
family |  | 1..1 | string | Surname
given |  | 1..2 | string | Given and middle names
prefix |  | 0..1 | string | Title
Slices for telecom |  | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Closed by value:use, value:system
telecom:mobile | S | 0..1 | ContactPoint | A contact detail for the individual
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone
value | S | 1..1 | string | The actual contact point details
use |  | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: mobile
telecom:home | S | 0..1 | ContactPoint | A contact detail for the individual
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone
value | S | 1..1 | string | The actual contact point details
use |  | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: home
telecom:email | S | 0..1 | ContactPoint | A contact detail for the individual
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email
value | S | 1..1 | string | The actual contact point details
use |  | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: home
gender | S | 1..1 | code | male | female | other | unknown
birthDate | S | 1..1 | date | Date of birth extended for time and accuracy indicator
Slices for deceased[x] |  |  |  | Content/Rules for all slices
deceased[x]:deceasedBoolean | S | 0..1 | boolean | Deceased indicator
Slices for address |  | 0..* | AustralianAddress, Address | An address for the individual Slice: Unordered, Closed by value:use, value:type
address:residential | S | 0..1 | AustralianAddress, Address | An address in Australia for use within an Australian healthcare context
use |  | 1..1 | code | home | work | temp | old | billing - purpose of this address Required Pattern: home
type |  | 1..1 | code | postal | physical | both Required Pattern: physical
line |  | 0..2 | string | Street name, number, direction & P.O. Box etc.
generalPractitioner | S | 0..1 | Reference(Genie PractitionerRole) | Patient's nominated primary care provider
managingOrganization | S | 0..1 | Reference(Genie Organization) | Organization that is the custodian of the patient record
display |  | 1..1 | string | Practice name
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 0..* | AUBasePatient | A patient in an Australian healthcare context inv-pat-0: If present, birth time's date shall be the birth date
id | S Σ | 0..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
birthPlace |  | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
indigenousStatus |  | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
veteranStatus |  | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
closingTheGapRegistration |  | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
mothersMaidenName |  | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
interpreterRequired |  | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
dateOfArrival |  | 0..1 | date | The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
genderIdentity |  | 0..1 | (Complex) | The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example)
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: Gender Identity Response (extensible)
individualPronouns |  | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
recordedSexOrGender |  | 0..* | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier |  | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
identifier:ihi | S C | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
identifier:medicare | S | 0..1 | AUMedicareCardNumber | Medicare Card Number
identifier:dva |  | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
identifier:insurancemember | S | 0..1 | AUInsuranceMemberNumber | Insurance Member Number
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB
coding | Σ | 1..1 | Coding | Code defined by a terminology system
system | Σ | 1..1 | uri | System identifier namespace for the insurer that assigned the insurance member number Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | Insurance member number Example General: 123456
assigner | Σ | 1..1 | Reference(Organization) | Insurer
display | Σ | 1..1 | string | Name of insurer
identifier:mrn | S | 0..1 | AUMedicalRecordNumber | Medical Record Number (MRN)
active | ?!S Σ | 1..1 | boolean | Whether this patient's record is in active use
Slices for name | Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Closed by value:use
name:official | S Σ | 1..1 | HumanName | A name associated with the patient
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official
family | Σ | 1..1 | string | Surname
given | Σ | 1..2 | string | Given and middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..1 | string | Title This repeating element order: Prefixes appear in the correct order for presenting the name
Slices for telecom | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Closed by value:use, value:system
telecom:mobile | S Σ | 0..1 | ContactPoint | A contact detail for the individual
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: mobile
telecom:home | S Σ | 0..1 | ContactPoint | A contact detail for the individual
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home
telecom:email | S Σ | 0..1 | ContactPoint | A contact detail for the individual
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | S Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Slices for extension |  |  |  | Content/Rules for all slices
accuracyIndicator |  | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Slices for deceased[x] | ?!Σ | 0..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedBoolean | ?!S Σ | 0..1 | boolean | Deceased indicator
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time
Slices for extension |  |  |  | Content/Rules for all slices
accuracyIndicator |  | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
Slices for address | C | 0..* | AustralianAddress, Address | An address for the individual Slice: Unordered, Closed by value:use, value:type inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
address:residential | S C | 0..1 | AustralianAddress, Address | An address in Australia for use within an Australian healthcare context inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
Slices for extension |  |  |  | Content/Rules for all slices
identifier |  | 0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
url |  | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x] |  | 1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | An identifier intended for computation
noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
use | ?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home
type | Σ C | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical
text | Σ C | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ C | 0..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
generalPractitioner | S | 0..1 | Reference(Genie PractitionerRole) | Patient's nominated primary care provider
managingOrganization | S Σ | 0..1 | Reference(Genie Organization) | Organization that is the custodian of the patient record
display | Σ | 1..1 | string | Practice name
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Patient.extension:genderIdentity.value[x] | example | GenderIdentity `http://hl7.org/fhir/ValueSet/gender-identity` from the FHIR Standard
Patient.extension:genderIdentity.value[x]:valueCodeableConcept | extensible | GenderIdentityResponse `https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1` from https://tx.ontoserver.csiro.au/fhir
Patient.identifier:insurancemember.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Patient.identifier:insurancemember.type | extensible | Pattern: MB `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Patient.name:official.use | required | Fixed Value: official `http://hl7.org/fhir/ValueSet/name-use|4.0.1` from the FHIR Standard
Patient.telecom:mobile.system | required | Pattern: phone `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Patient.telecom:mobile.use | required | Pattern: mobile `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
Patient.telecom:home.system | required | Pattern: phone `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Patient.telecom:home.use | required | Pattern: home `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
Patient.telecom:email.system | required | Pattern: email `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Patient.telecom:email.use | required | Pattern: home `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` from the FHIR Standard
Patient.address:residential.use | required | Pattern: home `http://hl7.org/fhir/ValueSet/address-use|4.0.1` from the FHIR Standard
Patient.address:residential.type | required | Pattern: physical `http://hl7.org/fhir/ValueSet/address-type|4.0.1` from the FHIR Standard
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-add-0 | error | Patient.address, Patient.address:residential | The address shall at least have text or a line : text.exists() or line.exists() |
inv-add-1 | error | Patient.address, Patient.address:residential | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' |
inv-add-2 | error | Patient.address, Patient.address:residential | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') |
inv-ihi-value-0 | error | Patient.identifier:ihi | IHI shall be an exactly 16 digit number : value.matches('^([0-9]{16})$') |
inv-ihi-value-1 | error | Patient.identifier:ihi | IHI prefix is 800360 : value.startsWith('800360') |
inv-ihi-value-2 | error | Patient.identifier:ihi | IHI shall pass the Luhn algorithm check : (((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) |
inv-pat-0 | error | Patient | If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 0..* | AUBasePatient | A patient in an Australian healthcare context inv-pat-0: If present, birth time's date shall be the birth date
id | S Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
birthPlace |  | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
indigenousStatus |  | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
veteranStatus |  | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
closingTheGapRegistration |  | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
mothersMaidenName |  | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
interpreterRequired |  | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
dateOfArrival |  | 0..1 | date | The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
genderIdentity |  | 0..1 | (Complex) | The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example)
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: Gender Identity Response (extensible)
individualPronouns |  | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
recordedSexOrGender |  | 0..* | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier |  | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
identifier:ihi | S C | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
identifier:medicare | S | 0..1 | AUMedicareCardNumber | Medicare Card Number
identifier:dva |  | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
identifier:insurancemember | S | 0..1 | AUInsuranceMemberNumber | Insurance Member Number
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept
system | Σ | 1..1 | uri | System identifier namespace for the insurer that assigned the insurance member number Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | Insurance member number Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 1..1 | Reference(Organization) | Insurer
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 1..1 | string | Name of insurer
identifier:mrn | S | 0..1 | AUMedicalRecordNumber | Medical Record Number (MRN)
active | ?!S Σ | 1..1 | boolean | Whether this patient's record is in active use
Slices for name | Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Closed by value:use
name:official | S Σ | 1..1 | HumanName | A name associated with the patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official
text | Σ | 0..1 | string | Text representation of the full name
family | Σ | 1..1 | string | Surname
given | Σ | 1..2 | string | Given and middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..1 | string | Title This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
Slices for telecom | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Closed by value:use, value:system
telecom:mobile | S Σ | 0..1 | ContactPoint | A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: mobile
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
telecom:home | S Σ | 0..1 | ContactPoint | A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
telecom:email | S Σ | 0..1 | ContactPoint | A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | S Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
accuracyIndicator |  | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value |  | 0..1 | date | Primitive value for date
Slices for deceased[x] | ?!Σ | 0..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedBoolean | ?!S Σ | 0..1 | boolean | Deceased indicator
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
accuracyIndicator |  | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
value |  | 0..1 | dateTime | Primitive value for dateTime
Slices for address | C | 0..* | AustralianAddress, Address | An address for the individual Slice: Unordered, Closed by value:use, value:type inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
address:residential | S C | 0..1 | AustralianAddress, Address | An address in Australia for use within an Australian healthcare context inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
identifier |  | 0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x] |  | 1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | An identifier intended for computation
noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
use | ?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home
type | Σ C | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical
text | Σ C | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ C | 0..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town or suburb Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required)
postalCode | Σ C | 0..1 | string | Postal code for area inv-add-3: Postal code shall be 4 digits Example General: 9132
country | Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type (extensible)
name |  | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address |  | 0..1 | Address, AustralianAddress | Address for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner | S | 0..1 | Reference(Genie PractitionerRole) | Patient's nominated primary care provider
managingOrganization | S Σ | 0..1 | Reference(Genie Organization) | Organization that is the custodian of the patient record
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 1..1 | string | Practice name
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Patient.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Patient.extension:genderIdentity.value[x] | example | GenderIdentity `http://hl7.org/fhir/ValueSet/gender-identity` from the FHIR Standard
Patient.extension:genderIdentity.value[x]:valueCodeableConcept | extensible | GenderIdentityResponse `https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1` from https://tx.ontoserver.csiro.au/fhir
Patient.identifier:insurancemember.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Patient.identifier:insurancemember.type | extensible | Pattern: MB `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Patient.identifier:insurancemember.assigner.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Patient.name:official.use | required | Fixed Value: official `http://hl7.org/fhir/ValueSet/name-use|4.0.1` from the FHIR Standard
Patient.telecom:mobile.system | required | Pattern: phone `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Patient.telecom:mobile.use | required | Pattern: mobile `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
Patient.telecom:home.system | required | Pattern: phone `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Patient.telecom:home.use | required | Pattern: home `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
Patient.telecom:email.system | required | Pattern: email `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Patient.telecom:email.use | required | Pattern: home `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` from the FHIR Standard
Patient.address:residential.use | required | Pattern: home `http://hl7.org/fhir/ValueSet/address-use|4.0.1` from the FHIR Standard
Patient.address:residential.type | required | Pattern: physical `http://hl7.org/fhir/ValueSet/address-type|4.0.1` from the FHIR Standard
Patient.address:residential.state | required | AustralianStatesAndTerritories `https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2` from https://tx.ontoserver.csiro.au/fhir
Patient.maritalStatus | extensible | Marital Status Codes `http://hl7.org/fhir/ValueSet/marital-status` from the FHIR Standard
Patient.contact.relationship | extensible | ContactRelationshipType `https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3` from https://tx.ontoserver.csiro.au/fhir
Patient.contact.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` from the FHIR Standard
Patient.communication.language | extensible | CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` from https://tx.ontoserver.csiro.au/fhir
Patient.managingOrganization.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-add-0 | error | Patient.address, Patient.address:residential | The address shall at least have text or a line : text.exists() or line.exists() |
inv-add-1 | error | Patient.address, Patient.address:residential | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' |
inv-add-2 | error | Patient.address, Patient.address:residential | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') |
inv-add-3 | error | Patient.address:residential.postalCode | Postal code shall be 4 digits : matches('^[0-9]{4}$') |
inv-ihi-value-0 | error | Patient.identifier:ihi | IHI shall be an exactly 16 digit number : value.matches('^([0-9]{16})$') |
inv-ihi-value-1 | error | Patient.identifier:ihi | IHI prefix is 800360 : value.startsWith('800360') |
inv-ihi-value-2 | error | Patient.identifier:ihi | IHI shall pass the Luhn algorithm check : (((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) |
inv-pat-0 | error | Patient | If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString() |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |

This structure is derived from AUBasePatient

Summary

Mandatory: 8 elements(13 nested mandatory elements)
Must-Support: 19 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- AU IHI (http://hl7.org.au/fhir/StructureDefinition/au-ihi)
- AU Medicare Card Number (http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber)
- AU DVA Number (http://hl7.org.au/fhir/StructureDefinition/au-dvanumber)
- AU Insurance Member Number (http://hl7.org.au/fhir/StructureDefinition/au-insurancemembernumber)
- AU Medical Record Number (http://hl7.org.au/fhir/StructureDefinition/au-medicalrecordnumber)
- Genie PractitionerRole (http://fhir.geniesolutions.io/StructureDefinition/gs-practitionerrole)
- Genie Organization (http://fhir.geniesolutions.io/StructureDefinition/gs-organization)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Patient.identifier
- The element 1 is sliced based on the value of Patient.name (Closed)
- The element 2 is sliced based on the values of Patient.telecom (Closed)
- The element 2 is sliced based on the values of Patient.address (Closed)

Differential View

This structure is derived from AUBasePatient

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  |  | AUBasePatient |
id | S | 0..1 | id | Logical id of this artifact
Slices for identifier |  | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
identifier:ihi | S | 0..1 | AUIHI | Individual Healthcare Identifier (IHI)
identifier:medicare | S | 0..1 | AUMedicareCardNumber | Medicare Card Number
identifier:dva |  | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
identifier:insurancemember | S | 0..1 | AUInsuranceMemberNumber | Insurance Member Number
type |  |  |  |
coding |  | 1..1 | Coding | Code defined by a terminology system
identifier:mrn | S | 0..1 | AUMedicalRecordNumber | Medical Record Number (MRN)
active | S | 1..1 | boolean | Whether this patient's record is in active use
Slices for name |  | 1..* | HumanName | A name associated with the patient Slice: Unordered, Closed by value:use
name:official | S | 1..1 | HumanName | A name associated with the patient
use |  | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official
family |  | 1..1 | string | Surname
given |  | 1..2 | string | Given and middle names
prefix |  | 0..1 | string | Title
Slices for telecom |  | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Closed by value:use, value:system
telecom:mobile | S | 0..1 | ContactPoint | A contact detail for the individual
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone
value | S | 1..1 | string | The actual contact point details
use |  | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: mobile
telecom:home | S | 0..1 | ContactPoint | A contact detail for the individual
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone
value | S | 1..1 | string | The actual contact point details
use |  | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: home
telecom:email | S | 0..1 | ContactPoint | A contact detail for the individual
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email
value | S | 1..1 | string | The actual contact point details
use |  | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: home
gender | S | 1..1 | code | male | female | other | unknown
birthDate | S | 1..1 | date | Date of birth extended for time and accuracy indicator
Slices for deceased[x] |  |  |  | Content/Rules for all slices
deceased[x]:deceasedBoolean | S | 0..1 | boolean | Deceased indicator
Slices for address |  | 0..* | AustralianAddress, Address | An address for the individual Slice: Unordered, Closed by value:use, value:type
address:residential | S | 0..1 | AustralianAddress, Address | An address in Australia for use within an Australian healthcare context
use |  | 1..1 | code | home | work | temp | old | billing - purpose of this address Required Pattern: home
type |  | 1..1 | code | postal | physical | both Required Pattern: physical
line |  | 0..2 | string | Street name, number, direction & P.O. Box etc.
generalPractitioner | S | 0..1 | Reference(Genie PractitionerRole) | Patient's nominated primary care provider
managingOrganization | S | 0..1 | Reference(Genie Organization) | Organization that is the custodian of the patient record
display |  | 1..1 | string | Practice name
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 0..* | AUBasePatient | A patient in an Australian healthcare context inv-pat-0: If present, birth time's date shall be the birth date
id | S Σ | 0..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
birthPlace |  | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
indigenousStatus |  | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
veteranStatus |  | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
closingTheGapRegistration |  | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
mothersMaidenName |  | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
interpreterRequired |  | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
dateOfArrival |  | 0..1 | date | The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
genderIdentity |  | 0..1 | (Complex) | The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example)
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: Gender Identity Response (extensible)
individualPronouns |  | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
recordedSexOrGender |  | 0..* | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier |  | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
identifier:ihi | S C | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
identifier:medicare | S | 0..1 | AUMedicareCardNumber | Medicare Card Number
identifier:dva |  | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
identifier:insurancemember | S | 0..1 | AUInsuranceMemberNumber | Insurance Member Number
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB
coding | Σ | 1..1 | Coding | Code defined by a terminology system
system | Σ | 1..1 | uri | System identifier namespace for the insurer that assigned the insurance member number Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | Insurance member number Example General: 123456
assigner | Σ | 1..1 | Reference(Organization) | Insurer
display | Σ | 1..1 | string | Name of insurer
identifier:mrn | S | 0..1 | AUMedicalRecordNumber | Medical Record Number (MRN)
active | ?!S Σ | 1..1 | boolean | Whether this patient's record is in active use
Slices for name | Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Closed by value:use
name:official | S Σ | 1..1 | HumanName | A name associated with the patient
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official
family | Σ | 1..1 | string | Surname
given | Σ | 1..2 | string | Given and middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..1 | string | Title This repeating element order: Prefixes appear in the correct order for presenting the name
Slices for telecom | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Closed by value:use, value:system
telecom:mobile | S Σ | 0..1 | ContactPoint | A contact detail for the individual
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: mobile
telecom:home | S Σ | 0..1 | ContactPoint | A contact detail for the individual
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home
telecom:email | S Σ | 0..1 | ContactPoint | A contact detail for the individual
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | S Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Slices for extension |  |  |  | Content/Rules for all slices
accuracyIndicator |  | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Slices for deceased[x] | ?!Σ | 0..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedBoolean | ?!S Σ | 0..1 | boolean | Deceased indicator
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time
Slices for extension |  |  |  | Content/Rules for all slices
accuracyIndicator |  | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
Slices for address | C | 0..* | AustralianAddress, Address | An address for the individual Slice: Unordered, Closed by value:use, value:type inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
address:residential | S C | 0..1 | AustralianAddress, Address | An address in Australia for use within an Australian healthcare context inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
Slices for extension |  |  |  | Content/Rules for all slices
identifier |  | 0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
url |  | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x] |  | 1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | An identifier intended for computation
noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
use | ?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home
type | Σ C | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical
text | Σ C | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ C | 0..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
generalPractitioner | S | 0..1 | Reference(Genie PractitionerRole) | Patient's nominated primary care provider
managingOrganization | S Σ | 0..1 | Reference(Genie Organization) | Organization that is the custodian of the patient record
display | Σ | 1..1 | string | Practice name
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Patient.extension:genderIdentity.value[x] | example | GenderIdentity `http://hl7.org/fhir/ValueSet/gender-identity` from the FHIR Standard
Patient.extension:genderIdentity.value[x]:valueCodeableConcept | extensible | GenderIdentityResponse `https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1` from https://tx.ontoserver.csiro.au/fhir
Patient.identifier:insurancemember.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Patient.identifier:insurancemember.type | extensible | Pattern: MB `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Patient.name:official.use | required | Fixed Value: official `http://hl7.org/fhir/ValueSet/name-use|4.0.1` from the FHIR Standard
Patient.telecom:mobile.system | required | Pattern: phone `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Patient.telecom:mobile.use | required | Pattern: mobile `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
Patient.telecom:home.system | required | Pattern: phone `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Patient.telecom:home.use | required | Pattern: home `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
Patient.telecom:email.system | required | Pattern: email `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Patient.telecom:email.use | required | Pattern: home `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` from the FHIR Standard
Patient.address:residential.use | required | Pattern: home `http://hl7.org/fhir/ValueSet/address-use|4.0.1` from the FHIR Standard
Patient.address:residential.type | required | Pattern: physical `http://hl7.org/fhir/ValueSet/address-type|4.0.1` from the FHIR Standard
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-add-0 | error | Patient.address, Patient.address:residential | The address shall at least have text or a line : text.exists() or line.exists() |
inv-add-1 | error | Patient.address, Patient.address:residential | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' |
inv-add-2 | error | Patient.address, Patient.address:residential | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') |
inv-ihi-value-0 | error | Patient.identifier:ihi | IHI shall be an exactly 16 digit number : value.matches('^([0-9]{16})$') |
inv-ihi-value-1 | error | Patient.identifier:ihi | IHI prefix is 800360 : value.startsWith('800360') |
inv-ihi-value-2 | error | Patient.identifier:ihi | IHI shall pass the Luhn algorithm check : (((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) |
inv-pat-0 | error | Patient | If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 0..* | AUBasePatient | A patient in an Australian healthcare context inv-pat-0: If present, birth time's date shall be the birth date
id | S Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
birthPlace |  | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
indigenousStatus |  | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
veteranStatus |  | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
closingTheGapRegistration |  | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
mothersMaidenName |  | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
interpreterRequired |  | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
dateOfArrival |  | 0..1 | date | The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
genderIdentity |  | 0..1 | (Complex) | The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example)
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: Gender Identity Response (extensible)
individualPronouns |  | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
recordedSexOrGender |  | 0..* | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier |  | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
identifier:ihi | S C | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
identifier:medicare | S | 0..1 | AUMedicareCardNumber | Medicare Card Number
identifier:dva |  | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
identifier:insurancemember | S | 0..1 | AUInsuranceMemberNumber | Insurance Member Number
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept
system | Σ | 1..1 | uri | System identifier namespace for the insurer that assigned the insurance member number Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | Insurance member number Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 1..1 | Reference(Organization) | Insurer
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 1..1 | string | Name of insurer
identifier:mrn | S | 0..1 | AUMedicalRecordNumber | Medical Record Number (MRN)
active | ?!S Σ | 1..1 | boolean | Whether this patient's record is in active use
Slices for name | Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Closed by value:use
name:official | S Σ | 1..1 | HumanName | A name associated with the patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official
text | Σ | 0..1 | string | Text representation of the full name
family | Σ | 1..1 | string | Surname
given | Σ | 1..2 | string | Given and middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..1 | string | Title This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
Slices for telecom | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Closed by value:use, value:system
telecom:mobile | S Σ | 0..1 | ContactPoint | A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: mobile
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
telecom:home | S Σ | 0..1 | ContactPoint | A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
telecom:email | S Σ | 0..1 | ContactPoint | A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | S Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
accuracyIndicator |  | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value |  | 0..1 | date | Primitive value for date
Slices for deceased[x] | ?!Σ | 0..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedBoolean | ?!S Σ | 0..1 | boolean | Deceased indicator
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
accuracyIndicator |  | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
value |  | 0..1 | dateTime | Primitive value for dateTime
Slices for address | C | 0..* | AustralianAddress, Address | An address for the individual Slice: Unordered, Closed by value:use, value:type inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
address:residential | S C | 0..1 | AustralianAddress, Address | An address in Australia for use within an Australian healthcare context inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
identifier |  | 0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x] |  | 1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | An identifier intended for computation
noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
use | ?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home
type | Σ C | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical
text | Σ C | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ C | 0..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town or suburb Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required)
postalCode | Σ C | 0..1 | string | Postal code for area inv-add-3: Postal code shall be 4 digits Example General: 9132
country | Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type (extensible)
name |  | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address |  | 0..1 | Address, AustralianAddress | Address for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner | S | 0..1 | Reference(Genie PractitionerRole) | Patient's nominated primary care provider
managingOrganization | S Σ | 0..1 | Reference(Genie Organization) | Organization that is the custodian of the patient record
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 1..1 | string | Practice name
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Patient.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Patient.extension:genderIdentity.value[x] | example | GenderIdentity `http://hl7.org/fhir/ValueSet/gender-identity` from the FHIR Standard
Patient.extension:genderIdentity.value[x]:valueCodeableConcept | extensible | GenderIdentityResponse `https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1` from https://tx.ontoserver.csiro.au/fhir
Patient.identifier:insurancemember.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Patient.identifier:insurancemember.type | extensible | Pattern: MB `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Patient.identifier:insurancemember.assigner.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Patient.name:official.use | required | Fixed Value: official `http://hl7.org/fhir/ValueSet/name-use|4.0.1` from the FHIR Standard
Patient.telecom:mobile.system | required | Pattern: phone `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Patient.telecom:mobile.use | required | Pattern: mobile `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
Patient.telecom:home.system | required | Pattern: phone `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Patient.telecom:home.use | required | Pattern: home `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
Patient.telecom:email.system | required | Pattern: email `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Patient.telecom:email.use | required | Pattern: home `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` from the FHIR Standard
Patient.address:residential.use | required | Pattern: home `http://hl7.org/fhir/ValueSet/address-use|4.0.1` from the FHIR Standard
Patient.address:residential.type | required | Pattern: physical `http://hl7.org/fhir/ValueSet/address-type|4.0.1` from the FHIR Standard
Patient.address:residential.state | required | AustralianStatesAndTerritories `https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2` from https://tx.ontoserver.csiro.au/fhir
Patient.maritalStatus | extensible | Marital Status Codes `http://hl7.org/fhir/ValueSet/marital-status` from the FHIR Standard
Patient.contact.relationship | extensible | ContactRelationshipType `https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3` from https://tx.ontoserver.csiro.au/fhir
Patient.contact.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` from the FHIR Standard
Patient.communication.language | extensible | CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` from https://tx.ontoserver.csiro.au/fhir
Patient.managingOrganization.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-add-0 | error | Patient.address, Patient.address:residential | The address shall at least have text or a line : text.exists() or line.exists() |
inv-add-1 | error | Patient.address, Patient.address:residential | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' |
inv-add-2 | error | Patient.address, Patient.address:residential | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') |
inv-add-3 | error | Patient.address:residential.postalCode | Postal code shall be 4 digits : matches('^[0-9]{4}$') |
inv-ihi-value-0 | error | Patient.identifier:ihi | IHI shall be an exactly 16 digit number : value.matches('^([0-9]{16})$') |
inv-ihi-value-1 | error | Patient.identifier:ihi | IHI prefix is 800360 : value.startsWith('800360') |
inv-ihi-value-2 | error | Patient.identifier:ihi | IHI shall pass the Luhn algorithm check : (((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) |
inv-pat-0 | error | Patient | If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString() |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |

This structure is derived from AUBasePatient

Summary

Mandatory: 8 elements(13 nested mandatory elements)
Must-Support: 19 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- AU IHI (http://hl7.org.au/fhir/StructureDefinition/au-ihi)
- AU Medicare Card Number (http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber)
- AU DVA Number (http://hl7.org.au/fhir/StructureDefinition/au-dvanumber)
- AU Insurance Member Number (http://hl7.org.au/fhir/StructureDefinition/au-insurancemembernumber)
- AU Medical Record Number (http://hl7.org.au/fhir/StructureDefinition/au-medicalrecordnumber)
- Genie PractitionerRole (http://fhir.geniesolutions.io/StructureDefinition/gs-practitionerrole)
- Genie Organization (http://fhir.geniesolutions.io/StructureDefinition/gs-organization)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Patient.identifier
- The element 1 is sliced based on the value of Patient.name (Closed)
- The element 2 is sliced based on the values of Patient.telecom (Closed)
- The element 2 is sliced based on the values of Patient.address (Closed)

Other representations of profile: CSV, Excel, Schematron