My Health Record FHIR IG
1.2.0 - active

My Health Record FHIR IG - Local Development build (v1.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: MHR Patient

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-mhr-1 | Version: 1.2.0
Active as of 2024-09-19 | Computable Name: MHRPatient
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to provide a representation of a patient for exchange usage scenarios with the My Health Record system infrastructure in Australia. This profile is derived from the AU Core Patient profile and describes the data structures and obligations to be met when conforming to this profile.

Usage:

- Refer to this Resource Profile: MHR Medical Conditions View AllergyIntolerance, MHR Medical Conditions View Document Composition, MHR Medical Conditions View Condition, MHR DocumentReference... Show 4 more, MHR Medical Conditions View Explanation of Benefit, MHR Medical Conditions View Flag, MHR Medical Conditions View Observation and MHR Medical Conditions View Procedure
- Examples for this Resource Profile: Patient/broadway-mike, Patient/lobster-larry and Patient/zhu-lily

### 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 AUCorePatient

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:ihi | O | 1..1 | AUIHI | Individual Healthcare Identifier (IHI)
Obligations | Actor
SHALL:handle | MHR Gateway Requester
name |  |  |  |
family | O | 1..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:handle | MHR Gateway Requester
given | O | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor
SHALL:handle | MHR Gateway Requester
gender | O | 1..1 | code | male | female | other | unknown
Obligations | Actor
SHALL:handle | MHR Gateway Requester
birthDate | O | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor
SHALL:handle | MHR Gateway Requester
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply au-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present au-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
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 | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 | SO C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
individualPronouns | SO C | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
identifier:ihi | SO C | 1..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
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
identifier:medicare | SO | 0..1 | AUMedicareCardNumber | Medicare Card Number
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
identifier:dva | SO | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
use | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
family | SO Σ | 1..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
given | SO Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
gender | SO Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
birthDate | SO Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
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 |  | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
deceased[x]:deceasedBoolean | ?!Σ | 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
address | SO C | 0..* | AustralianAddress, Address | An address for the individual 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'
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | SO | 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)
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 | URI
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-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.communication.language | extensible | CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` from https://tx.ontoserver.csiro.au/fhir
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply au-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present au-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
id | Σ | 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 | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 | SO C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
individualPronouns | SO C | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
identifier:ihi | SO C | 1..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
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
identifier:medicare | SO | 0..1 | AUMedicareCardNumber | Medicare Card Number
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
identifier:dva | SO | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
family | SO Σ | 1..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
given | SO Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
prefix | Σ | 0..* | string | Parts that come before the name 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
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
gender | SO Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
birthDate | SO Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
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 |  | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
deceased[x]:deceasedBoolean | ?!Σ | 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
address | SO C | 0..* | AustralianAddress, Address | An address for the individual 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'
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 | SO | 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)
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
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 | URI
Patient.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-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.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.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

This structure is derived from AUCorePatient

Summary

Mandatory: 2 elements

Differential View

This structure is derived from AUCorePatient

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:ihi | O | 1..1 | AUIHI | Individual Healthcare Identifier (IHI)
Obligations | Actor
SHALL:handle | MHR Gateway Requester
name |  |  |  |
family | O | 1..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:handle | MHR Gateway Requester
given | O | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor
SHALL:handle | MHR Gateway Requester
gender | O | 1..1 | code | male | female | other | unknown
Obligations | Actor
SHALL:handle | MHR Gateway Requester
birthDate | O | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor
SHALL:handle | MHR Gateway Requester
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply au-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present au-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
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 | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 | SO C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
individualPronouns | SO C | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
identifier:ihi | SO C | 1..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
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
identifier:medicare | SO | 0..1 | AUMedicareCardNumber | Medicare Card Number
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
identifier:dva | SO | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
use | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
family | SO Σ | 1..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
given | SO Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
gender | SO Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
birthDate | SO Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
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 |  | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
deceased[x]:deceasedBoolean | ?!Σ | 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
address | SO C | 0..* | AustralianAddress, Address | An address for the individual 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'
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | SO | 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)
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 | URI
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-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.communication.language | extensible | CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` from https://tx.ontoserver.csiro.au/fhir
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply au-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present au-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
id | Σ | 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 | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 | SO C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
individualPronouns | SO C | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
identifier:ihi | SO C | 1..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
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
identifier:medicare | SO | 0..1 | AUMedicareCardNumber | Medicare Card Number
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
identifier:dva | SO | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
family | SO Σ | 1..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
given | SO Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
prefix | Σ | 0..* | string | Parts that come before the name 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
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
gender | SO Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
birthDate | SO Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
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 |  | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
deceased[x]:deceasedBoolean | ?!Σ | 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
address | SO C | 0..* | AustralianAddress, Address | An address for the individual 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'
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 | SO | 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)
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
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 | URI
Patient.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-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.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.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

This structure is derived from AUCorePatient

Summary

Mandatory: 2 elements

Other representations of profile: CSV, Excel, Schematron