AU eRequesting Implementation Guide
1.0.0 - Working Standard

AU eRequesting Implementation Guide - Downloaded Version 1.0.0 See the Directory of published versions

## Resource Profile: AU eRequesting Patient

Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-patient | Version: 1.0.0
Standards status: Trial-use | Maturity Level: 1 | Computable Name: AUeRequestingPatient
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It is based on the AU Core Patient profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Patient resource when conforming to this profile.

### Profile Specific Implementation Guidance

- See the general guidance on implementing the Patient resource in AU Core Patient.
- This profile supports the sex, gender, and related concepts of: Name to Use, Gender Identity, and Individual Pronouns. See the Sex and Gender page for guidance on exchanging sex and gender related concepts conformant to AU eRequesting.

Obligations for AU Core actors (AU Core Requester and AU Core Responder) inherited from AU Core Patient currently render in the profile view. This is a tooling limitation, and only the AU eRequesting actor obligations should be applied. See Zulip discussion for more information.

Usages:

- Refer to this Profile: AU eRequesting Clinical Context DocumentReference, AU eRequesting CommunicationRequest Patient, AU eRequesting CommunicationRequest, AU eRequesting Coverage... Show 4 more, AU eRequesting Diagnostic Request, AU eRequesting Encounter, AU eRequesting MHR Consent Withdrawal and AU eRequesting Task
- Examples for this Profile: Patient/belger-remedios, Patient/roberts-fred and Patient/scott-elijah-ken
- CapabilityStatements using this Profile: AU eRequesting Filler CapabilityStatement, AU eRequesting Patient CapabilityStatement, AU eRequesting Placer CapabilityStatement and AU eRequesting Server CapabilityStatement

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, inv-pat-6, 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 |  | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
extension:recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
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
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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 & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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, Address | 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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 | FHIR Std.
Patient.communication.​language | Base | extensible | Common Languages in Australia | ⏿2.2.1 | tx.hl7.org.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-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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(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').extension('value').value.all(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').extension('type').value.all(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').extension('sourceDocument').value.ofType(CodeableConcept).all(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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))`
inv-pat-6 | warning | Patient | Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))`

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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
extension:genderIdentity | O | 0..* | PGenderIdentity(5.2.0) | The individual's gender identity
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
extension:individualPronouns | O | 0..* | Pronouns(5.2.0) | The pronouns to use when communicating about an individual.
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
identifier | O | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:ihi | O | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
identifier:medicare | O | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
identifier:dva | O | 0..1 | AUDVANumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
name | O | 1..* | HumanName | A name associated with the patient
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
use | O | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
text | O | 0..1 | string | Text representation of the full name
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
family | O | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
given | O | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
telecom | O | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
system | O | 0..1 | code | phone | fax | email | pager | url | sms | other
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
value | O | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
use | O | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
gender | O | 1..1 | code | male | female | other | unknown
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
birthDate | O | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
address | O | 0..* | AustralianAddress, Address | An address for the individual
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
communication | O | 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
language | O | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
preferred | O | 0..1 | boolean | Language preference indicator
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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, inv-pat-6, 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 |  | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
extension:recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
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
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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 & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor | 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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, Address | 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type (extensible)
name |  | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address |  | 0..1 | Address, AustralianAddress | Address for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor | 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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 | FHIR Std.
Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.0.1 | FHIR Std.
Patient.contact.relationship | Base | extensible | Contact Relationship Type | ⏿3.1.0 | tx.hl7.org.au
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | extensible | Common Languages in Australia | ⏿2.2.1 | tx.hl7.org.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-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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(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').extension('value').value.all(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').extension('type').value.all(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').extension('sourceDocument').value.ofType(CodeableConcept).all(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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))`
inv-pat-6 | warning | Patient | Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))`
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

Maturity: 1

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, inv-pat-6, 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 |  | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
extension:recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
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
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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 & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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, Address | 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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 | FHIR Std.
Patient.communication.​language | Base | extensible | Common Languages in Australia | ⏿2.2.1 | tx.hl7.org.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-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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(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').extension('value').value.all(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').extension('type').value.all(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').extension('sourceDocument').value.ofType(CodeableConcept).all(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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))`
inv-pat-6 | warning | Patient | Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))`

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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
extension:genderIdentity | O | 0..* | PGenderIdentity(5.2.0) | The individual's gender identity
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
extension:individualPronouns | O | 0..* | Pronouns(5.2.0) | The pronouns to use when communicating about an individual.
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
identifier | O | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:ihi | O | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
identifier:medicare | O | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
identifier:dva | O | 0..1 | AUDVANumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
name | O | 1..* | HumanName | A name associated with the patient
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
use | O | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
text | O | 0..1 | string | Text representation of the full name
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
family | O | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
given | O | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
telecom | O | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
system | O | 0..1 | code | phone | fax | email | pager | url | sms | other
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
value | O | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
use | O | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
gender | O | 1..1 | code | male | female | other | unknown
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
birthDate | O | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
address | O | 0..* | AustralianAddress, Address | An address for the individual
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
communication | O | 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
language | O | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
preferred | O | 0..1 | boolean | Language preference indicator
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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, inv-pat-6, 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 |  | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
extension:recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
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
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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 & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor | 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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, Address | 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type (extensible)
name |  | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address |  | 0..1 | Address, AustralianAddress | Address for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor | 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 & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Patient
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Patient
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting 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 | FHIR Std.
Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.0.1 | FHIR Std.
Patient.contact.relationship | Base | extensible | Contact Relationship Type | ⏿3.1.0 | tx.hl7.org.au
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | extensible | Common Languages in Australia | ⏿2.2.1 | tx.hl7.org.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-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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(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').extension('value').value.all(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').extension('type').value.all(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').extension('sourceDocument').value.ofType(CodeableConcept).all(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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))`
inv-pat-6 | warning | Patient | Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply | `extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))`
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

Maturity: 1

Other representations of profile: CSV, Excel, Schematron

### Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU eRequesting CapabilityStatements for a complete list of supported RESTful interactions for this IG.

FHIR search operations are described here and the syntax used to describe AU eRequesting interactions is defined here.

Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT".

Parameter(s) | Server Conformance | Placer Conformance | Filler Conformance | Patient Conformance | Type(s) | Requirements (when used alone or in combination)
--- | --- | --- | --- | --- | --- | ---
_id | SHALL | MAY | MAY | MAY | `token` |
identifier | SHALL | MAY | MAY | MAY | `token` |

#### Search Parameters:

The following search parameters and search parameter combinations are supported. Conformance obligations are detailed in the table above.

1. `_id` search parameter

   `GET [base]/Patient?_id=[id]`

   Example:

   1. GET [base]/Patient?_id=456789

   Implementation Notes: Fetches a bundle with the requested Patient, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)

2. `identifier` search parameter:

   `GET [base]/Patient?identifier=[system|][code]`

   Example:

   1. GET [base]/Patient?identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

   Implementation Notes: Fetches a bundle containing all Patient resources matching the identifier (how to search by token)