Smart Health Checks
0.3.0 - ci-build

Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Smart Health Checks Patient

Official URL: https://smartforms.csiro.au/ig/StructureDefinition/SHCPatient | Version: 0.3.0
Draft as of 2025-10-01 | Computable Name: SmartHealthChecksPatient
Copyright/Legal: Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/.

This profile sets the minimum expectations for a Patient resource to search and retrieve patient information when used within Smart Health Checks.

Usages:

- Examples for this Profile: Patient/pat-sf
- CapabilityStatements using this Profile: SHC App and SHC Host FHIR Server

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:birthPlace |  | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:indigenousStatus | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:veteranStatus |  | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
extension:closingTheGapRegistration | SO | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
extension:mothersMaidenName |  | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
extension:interpreterRequired |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension: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
extension:genderIdentity | SO C | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:individualPronouns | SO C | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:recordedSexOrGender | SO C | 0..* | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
extension:sexParameterForClinicalUse |  | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:ihi | SO Σ | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:medicare | SO Σ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
identifier:dva | SO Σ | 0..1 | AUDVANumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:pensionerCard | SO Σ C | 0..1 | AUPensionerConcessionCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server | from AU Core Patient
SHALL:process | SHC App | from AU Core Patient
identifier:healthCareCard | SO Σ C | 0..1 | AUHealthCareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server | from AU Core Patient
SHALL:process | SHC App | from AU Core Patient
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
use | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
prefix | SO Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Obligations | Actor
SHALL:process | SHC App
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
system | SO Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
value | SO Σ | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
use | ?!SO Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
gender | SO Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
birthDate | SO Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate | SHC Host FHIR Server |
SHALL:process | SHC App |
Slices for extension |  |  |  | Content/Rules for all slices
extension: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
extension: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
extension: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 Σ | 0..* | AustralianAddress | An address for the individual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
Slices for extension |  |  |  | Content/Rules for all slices
extension: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 | Address identifier
extension:noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
use | ?!SO Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
type | SO Σ C | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
text | Σ C | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | SO Σ C | 0..* | 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
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
city | SO Σ | 0..1 | string | Name of city, town or suburb Example General: Erewhon
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
state | SO Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required)
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
postalCode | SO Σ C | 0..1 | string | Postal code for area Constraints: inv-add-3 Example General: 9132
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
country | Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU
contact | SO C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship | SO | 0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type (extensible)
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
name | SO | 0..1 | HumanName | A name associated with the contact person
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
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 | SHC Host FHIR Server
SHALL:process | SHC App
prefix | SO Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Obligations | Actor
SHALL:process | SHC App
telecom | SO | 0..* | ContactPoint | A contact detail for the person
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
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 | Status | Usage | ValueSet | Version | Source
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Patient.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | This IG
Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Patient.address.state | Base | required | Australian States and Territories | 📦2.0.2 | This IG
Patient.contact.relationship | Base | extensible | Contact Relationship Type | ⏿3.1.0 | tx.ontoserver.csiro.au
Patient.contact.name.​use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | extensible | Common Languages in Australia | ⏿2.2.1 | tx.ontoserver.csiro.au
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present | `(identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present | `name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present | `(text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
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-3 | error | Patient.address.postalCode | Postal code shall be 4 digits | `matches('^[0-9]{4}$')`
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()`
inv-pat-1 | warning | Patient | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply | `extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))`
inv-pat-2 | warning | Patient | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply | `extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))`
inv-pat-3 | warning | Patient | 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 | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))`
inv-pat-4 | warning | Patient | 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 | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))`
inv-pat-5 | warning | Patient | 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 | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))`
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 AUCorePatient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information
Slices for extension |  |  |  | Content/Rules for all slices
extension:indigenousStatus | O | 0..1 | AustralianIndigenousStatus | Indigenous status
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:closingTheGapRegistration | SO | 0..1 | ClosingTheGapRegistration | Closing the Gap co-payment eligibility indicator
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
extension:genderIdentity | O | 0..* | PGenderIdentity(5.3.0-ballot-tc1) | The individual's gender identity
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:individualPronouns | O | 0..* | Pronouns(5.3.0-ballot-tc1) | The pronouns to use when communicating about an individual.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:recordedSexOrGender | SO | 0..* | RecordedSexOrGender(5.3.0-ballot-tc1) | A recorded sex or gender property for the individual
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:medicare | O | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
identifier:pensionerCard | SO | 0..1 | AUPensionerConcessionCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | SHC Host FHIR Server | from AU Core Patient
SHALL:process | SHC App | from AU Core Patient
identifier:healthCareCard | SO | 0..1 | AUHealthCareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | SHC Host FHIR Server | from AU Core Patient
SHALL:process | SHC App | from AU Core Patient
name | O | 1..* | HumanName | A name associated with the patient
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
use | O | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
text | O | 0..1 | string | Text representation of the full name
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
family | O | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
given | O | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
prefix | SO | 0..* | string | Parts that come before the name
Obligations | Actor
SHALL:process | SHC App
telecom | O | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
system | O | 0..1 | code | phone | fax | email | pager | url | sms | other
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
value | O | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
use | O | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
gender | O | 1..1 | code | male | female | other | unknown
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
birthDate | O | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate | SHC Host FHIR Server |
SHALL:process | SHC App |
address | O | 0..* | AustralianAddress | An address for the individual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
use | SO | 0..1 | code | home | work | temp | old | billing - purpose of this address
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
type | SO | 0..1 | code | postal | physical | both
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
line | SO | 0..* | string | Street name, number, direction & P.O. Box etc.
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
city | SO | 0..1 | string | Name of city, town or suburb
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
state | SO | 0..1 | string | Australian state or territory
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
postalCode | SO | 0..1 | string | Postal code for area
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
contact | SO | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
relationship | SO | 0..* | CodeableConcept | The kind of relationship
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
name | SO | 0..1 | HumanName | A name associated with the contact person
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
family | SO | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
given | SO | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
prefix | SO | 0..* | string | Parts that come before the name
Obligations | Actor
SHALL:process | SHC App
telecom | SO | 0..* | ContactPoint | A contact detail for the person
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:birthPlace |  | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:indigenousStatus | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:veteranStatus |  | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
extension:closingTheGapRegistration | SO | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
extension:mothersMaidenName |  | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
extension:interpreterRequired |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension: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
extension:genderIdentity | SO C | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:individualPronouns | SO C | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:recordedSexOrGender | SO C | 0..* | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
extension:sexParameterForClinicalUse |  | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:ihi | SO Σ | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:medicare | SO Σ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
identifier:dva | SO Σ | 0..1 | AUDVANumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:pensionerCard | SO Σ C | 0..1 | AUPensionerConcessionCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server | from AU Core Patient
SHALL:process | SHC App | from AU Core Patient
identifier:healthCareCard | SO Σ C | 0..1 | AUHealthCareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server | from AU Core Patient
SHALL:process | SHC App | from AU Core Patient
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
prefix | SO Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Obligations | Actor
SHALL:process | SHC App
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
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 | SO Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
value | SO Σ | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
use | ?!SO Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
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 | SO Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
birthDate | SO Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate | SHC Host FHIR Server |
SHALL:process | SHC App |
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension: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
extension: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
extension: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 Σ | 0..* | AustralianAddress | An address for the individual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension: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 | Address identifier
extension:noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
use | ?!SO Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
type | SO Σ C | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
text | Σ C | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | SO Σ C | 0..* | 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
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
city | SO Σ | 0..1 | string | Name of city, town or suburb Example General: Erewhon
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | SO Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required)
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
postalCode | SO Σ C | 0..1 | string | Postal code for area Constraints: inv-add-3 Example General: 9132
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
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 | SO C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
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 | SO | 0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type (extensible)
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
name | SO | 0..1 | HumanName | A name associated with the contact person
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
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 | SHC Host FHIR Server
SHALL:process | SHC App
prefix | SO Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Obligations | Actor
SHALL:process | SHC App
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 person
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
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 | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Patient.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | This IG
Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Patient.address.state | Base | required | Australian States and Territories | 📦2.0.2 | This IG
Patient.maritalStatus | Base | extensible | MaritalStatus | 📦4.0.1 | FHIR Std.
Patient.contact.relationship | Base | extensible | Contact Relationship Type | ⏿3.1.0 | tx.ontoserver.csiro.au
Patient.contact.name.​use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | This IG
Patient.communication.​language | Base | extensible | Common Languages in Australia | ⏿2.2.1 | tx.ontoserver.csiro.au
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present | `(identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present | `name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present | `(text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
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-3 | error | Patient.address.postalCode | Postal code shall be 4 digits | `matches('^[0-9]{4}$')`
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()`
inv-pat-1 | warning | Patient | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply | `extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))`
inv-pat-2 | warning | Patient | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply | `extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))`
inv-pat-3 | warning | Patient | 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 | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))`
inv-pat-4 | warning | Patient | 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 | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))`
inv-pat-5 | warning | Patient | 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 | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))`
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 AUCorePatient

Summary

Must-Support: 18 elements

Structures

This structure refers to these other structures:

- AU Pensioner Concession Card Number (http://hl7.org.au/fhir/StructureDefinition/au-pensionerconcessioncardnumber)
- AU Health Care Card Number (http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber)
- Australian Address (http://hl7.org.au/fhir/StructureDefinition/au-address)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:birthPlace |  | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:indigenousStatus | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:veteranStatus |  | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
extension:closingTheGapRegistration | SO | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
extension:mothersMaidenName |  | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
extension:interpreterRequired |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension: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
extension:genderIdentity | SO C | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:individualPronouns | SO C | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:recordedSexOrGender | SO C | 0..* | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
extension:sexParameterForClinicalUse |  | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:ihi | SO Σ | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:medicare | SO Σ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
identifier:dva | SO Σ | 0..1 | AUDVANumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:pensionerCard | SO Σ C | 0..1 | AUPensionerConcessionCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server | from AU Core Patient
SHALL:process | SHC App | from AU Core Patient
identifier:healthCareCard | SO Σ C | 0..1 | AUHealthCareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server | from AU Core Patient
SHALL:process | SHC App | from AU Core Patient
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
use | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
prefix | SO Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Obligations | Actor
SHALL:process | SHC App
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
system | SO Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
value | SO Σ | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
use | ?!SO Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
gender | SO Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
birthDate | SO Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate | SHC Host FHIR Server |
SHALL:process | SHC App |
Slices for extension |  |  |  | Content/Rules for all slices
extension: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
extension: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
extension: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 Σ | 0..* | AustralianAddress | An address for the individual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
Slices for extension |  |  |  | Content/Rules for all slices
extension: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 | Address identifier
extension:noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
use | ?!SO Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
type | SO Σ C | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
text | Σ C | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | SO Σ C | 0..* | 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
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
city | SO Σ | 0..1 | string | Name of city, town or suburb Example General: Erewhon
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
state | SO Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required)
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
postalCode | SO Σ C | 0..1 | string | Postal code for area Constraints: inv-add-3 Example General: 9132
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
country | Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU
contact | SO C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship | SO | 0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type (extensible)
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
name | SO | 0..1 | HumanName | A name associated with the contact person
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
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 | SHC Host FHIR Server
SHALL:process | SHC App
prefix | SO Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Obligations | Actor
SHALL:process | SHC App
telecom | SO | 0..* | ContactPoint | A contact detail for the person
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
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 | Status | Usage | ValueSet | Version | Source
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Patient.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | This IG
Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Patient.address.state | Base | required | Australian States and Territories | 📦2.0.2 | This IG
Patient.contact.relationship | Base | extensible | Contact Relationship Type | ⏿3.1.0 | tx.ontoserver.csiro.au
Patient.contact.name.​use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | extensible | Common Languages in Australia | ⏿2.2.1 | tx.ontoserver.csiro.au
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present | `(identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present | `name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present | `(text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
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-3 | error | Patient.address.postalCode | Postal code shall be 4 digits | `matches('^[0-9]{4}$')`
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()`
inv-pat-1 | warning | Patient | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply | `extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))`
inv-pat-2 | warning | Patient | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply | `extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))`
inv-pat-3 | warning | Patient | 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 | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))`
inv-pat-4 | warning | Patient | 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 | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))`
inv-pat-5 | warning | Patient | 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 | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))`
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()`

Differential View

This structure is derived from AUCorePatient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information
Slices for extension |  |  |  | Content/Rules for all slices
extension:indigenousStatus | O | 0..1 | AustralianIndigenousStatus | Indigenous status
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:closingTheGapRegistration | SO | 0..1 | ClosingTheGapRegistration | Closing the Gap co-payment eligibility indicator
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
extension:genderIdentity | O | 0..* | PGenderIdentity(5.3.0-ballot-tc1) | The individual's gender identity
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:individualPronouns | O | 0..* | Pronouns(5.3.0-ballot-tc1) | The pronouns to use when communicating about an individual.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:recordedSexOrGender | SO | 0..* | RecordedSexOrGender(5.3.0-ballot-tc1) | A recorded sex or gender property for the individual
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:medicare | O | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
identifier:pensionerCard | SO | 0..1 | AUPensionerConcessionCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | SHC Host FHIR Server | from AU Core Patient
SHALL:process | SHC App | from AU Core Patient
identifier:healthCareCard | SO | 0..1 | AUHealthCareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | SHC Host FHIR Server | from AU Core Patient
SHALL:process | SHC App | from AU Core Patient
name | O | 1..* | HumanName | A name associated with the patient
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
use | O | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
text | O | 0..1 | string | Text representation of the full name
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
family | O | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
given | O | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
prefix | SO | 0..* | string | Parts that come before the name
Obligations | Actor
SHALL:process | SHC App
telecom | O | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
system | O | 0..1 | code | phone | fax | email | pager | url | sms | other
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
value | O | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
use | O | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
gender | O | 1..1 | code | male | female | other | unknown
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
birthDate | O | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate | SHC Host FHIR Server |
SHALL:process | SHC App |
address | O | 0..* | AustralianAddress | An address for the individual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
use | SO | 0..1 | code | home | work | temp | old | billing - purpose of this address
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
type | SO | 0..1 | code | postal | physical | both
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
line | SO | 0..* | string | Street name, number, direction & P.O. Box etc.
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
city | SO | 0..1 | string | Name of city, town or suburb
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
state | SO | 0..1 | string | Australian state or territory
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
postalCode | SO | 0..1 | string | Postal code for area
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
contact | SO | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
relationship | SO | 0..* | CodeableConcept | The kind of relationship
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
name | SO | 0..1 | HumanName | A name associated with the contact person
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
family | SO | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
given | SO | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
prefix | SO | 0..* | string | Parts that come before the name
Obligations | Actor
SHALL:process | SHC App
telecom | SO | 0..* | ContactPoint | A contact detail for the person
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:birthPlace |  | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:indigenousStatus | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:veteranStatus |  | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
extension:closingTheGapRegistration | SO | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
extension:mothersMaidenName |  | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
extension:interpreterRequired |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension: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
extension:genderIdentity | SO C | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:individualPronouns | SO C | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
extension:recordedSexOrGender | SO C | 0..* | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
extension:sexParameterForClinicalUse |  | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:ihi | SO Σ | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:medicare | SO Σ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
identifier:dva | SO Σ | 0..1 | AUDVANumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:pensionerCard | SO Σ C | 0..1 | AUPensionerConcessionCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server | from AU Core Patient
SHALL:process | SHC App | from AU Core Patient
identifier:healthCareCard | SO Σ C | 0..1 | AUHealthCareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server | from AU Core Patient
SHALL:process | SHC App | from AU Core Patient
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
prefix | SO Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Obligations | Actor
SHALL:process | SHC App
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
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 | SO Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
value | SO Σ | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
use | ?!SO Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
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 | SO Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
birthDate | SO Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate | SHC Host FHIR Server |
SHALL:process | SHC App |
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension: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
extension: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
extension: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 Σ | 0..* | AustralianAddress | An address for the individual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
SHALL:populate-if-known | SHC Host FHIR Server |
SHALL:process | SHC App |
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension: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 | Address identifier
extension:noFixedAddress | C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
use | ?!SO Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
type | SO Σ C | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
text | Σ C | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | SO Σ C | 0..* | 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
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
city | SO Σ | 0..1 | string | Name of city, town or suburb Example General: Erewhon
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | SO Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required)
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
postalCode | SO Σ C | 0..1 | string | Postal code for area Constraints: inv-add-3 Example General: 9132
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
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 | SO C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
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 | SO | 0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type (extensible)
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
name | SO | 0..1 | HumanName | A name associated with the contact person
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
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 | SHC Host FHIR Server
SHALL:process | SHC App
prefix | SO Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Obligations | Actor
SHALL:process | SHC App
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 person
Obligations | Actor
SHALL:populate-if-known | SHC Host FHIR Server
SHALL:process | SHC App
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
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 | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Patient.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | This IG
Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Patient.address.state | Base | required | Australian States and Territories | 📦2.0.2 | This IG
Patient.maritalStatus | Base | extensible | MaritalStatus | 📦4.0.1 | FHIR Std.
Patient.contact.relationship | Base | extensible | Contact Relationship Type | ⏿3.1.0 | tx.ontoserver.csiro.au
Patient.contact.name.​use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | This IG
Patient.communication.​language | Base | extensible | Common Languages in Australia | ⏿2.2.1 | tx.ontoserver.csiro.au
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present | `(identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present | `name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present | `(text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
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-3 | error | Patient.address.postalCode | Postal code shall be 4 digits | `matches('^[0-9]{4}$')`
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()`
inv-pat-1 | warning | Patient | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply | `extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))`
inv-pat-2 | warning | Patient | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply | `extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))`
inv-pat-3 | warning | Patient | 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 | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))`
inv-pat-4 | warning | Patient | 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 | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))`
inv-pat-5 | warning | Patient | 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 | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))`
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 AUCorePatient

Summary

Must-Support: 18 elements

Structures

This structure refers to these other structures:

- AU Pensioner Concession Card Number (http://hl7.org.au/fhir/StructureDefinition/au-pensionerconcessioncardnumber)
- AU Health Care Card Number (http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber)
- Australian Address (http://hl7.org.au/fhir/StructureDefinition/au-address)

Other representations of profile: CSV, Excel, Schematron