# Clinical Note Document

26.0.0 AU

Clinical Note Document - Local Development build (v26.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: CND Patient

Official URL: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/cnd-patient | Version: 26.0.0
Active as of 2026-06-19 | Computable Name: CND_Patient
Copyright/Legal: This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/

This profile constrains AU Core Patient to meet the requirements of this Implementation Guide for a patient or consumer. Implementers are highly encouraged to review AU Core Patient profile before using this profile. This profile defines a patient or a consumer of Clinical Note Document.

This profile defines patient identification and demographic requirements for a Clinical Note Document in Australia, ensuring consistent capture of consumer details including name and identity information for clinical note exchange across healthcare settings.

### Usage scenarios

The following are supported usage scenarios for this profile:

- Query for records associated with a patient
- Record or update a record associated with a patient
- Query for basic demographics and other administrative information about a patient
- Record or update basic demographics and other administrative information about a patient
- Read information about a patient referenced by another resource

### Profile specific implementation guidance

- An individual's IHI SHOULD be used in `Patient.identifier` if available, in preference to Medicare or DVA numbers.
- See guidance on the construction of identifiers in each Identifier profile and the section on Business Identifiers in AU Base.
- This profile supports the sex, gender, and related concepts of: Gender Identity
  - The Clinical Note Document follows the HL7 AU Base guidance for Administrative Gender (Patient.gender)".
  - The Clinical Note Document patient incorporates the Individual Gender Identity extension to facilitate the exchange of Patient's gender data (as outlined in the HL7 Gender Harmony IG).
- Patient names shall be provided in parts such as `name.family` and `name.given`
  - Clinical Note Document Preferred Name extension can be used to specify preferred name of the patient

Usages:

- Use this Profile: CND Bundle
- Refer to this Profile: CND Composition, CND DocumentReference and CND MedicationStatement
- Examples for this Profile: Patient/ex-patient-anne and Patient/ex-patient-smith

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 | Clinical Note Document Patient 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, inv-01-family-name-length-not-absent, inv-02-given-name-length-if-not-absent
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 2..* | 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 | 1..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
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 | 1..* | (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
extension:individualPronouns | SO C | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core 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 | S | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:informalCarer |  | 0..1 | (Complex) | Patient's informal carer information URL: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:ihi | SO Σ | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:medicare | SO Σ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
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
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
Slices for name | SO Σ C | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use 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
name:All Slices |  |  |  | Content/Rules for all slices
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
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
family | SO Σ | 1..1 | string | Patient's family 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
given | SO Σ | 0..* | string | Patient's given name 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
name:preferredName | SO Σ C | 0..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
use | ?!SO Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core 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
family | SO Σ | 1..1 | string | Patient's family 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
given | SO Σ | 0..* | string | Patient's given name 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
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
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
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
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
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
birthDate | SO Σ C | 1..1 | date | Patient's date of birth
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
Slices for extension |  |  |  | Content/Rules for all slices
extension:accuracyIndicator |  | 0..1 | Coding | Patient's date of birth 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
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.name:preferredName.​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.ontoserver.csiro.au
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present | `(identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present | `name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-03 | error | Patient.name, Patient.name:preferredName | 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-01-family-name-length-not-absent | warning | Patient | Family name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331 | `Patient.name.family.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.family.matches('^.{1,40}$')`
inv-02-given-name-length-if-not-absent | warning | Patient | Given name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331 | `Patient.name.given.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.given.matches('^.{1,40}$')`
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 | C | 0..* | AUCorePatient | Clinical Note Document Patient Constraints: inv-01-family-name-length-not-absent, inv-02-given-name-length-if-not-absent
extension |  | 2..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:indigenousStatus |  | 1..1 | AustralianIndigenousStatus | Indigenous status
extension:genderIdentity |  | 1..* | PGenderIdentity(5.3.0) | The individual's gender identity
extension:sexParameterForClinicalUse | S | 0..* | PatSexParameterForClinicalUse(5.3.0) | A context-specific sex parameter for clinical use
extension:informalCarer |  | 0..1 | (Complex) | Patient's informal carer information URL: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer
Slices for name |  | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use
name:All Slices |  |  |  | Content/Rules for all slices
family |  | 1..1 | string | Patient's family name
given |  | 0..* | string | Patient's given name
name:preferredName |  | 0..1 | HumanName | A name associated with the patient
use |  | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: usual
family |  | 1..1 | string | Patient's family name
birthDate |  | 1..1 | date | Patient's date of birth
Slices for extension |  |  |  | Content/Rules for all slices
extension:accuracyIndicator |  | 0..1 | DateAccuracyIndicator | Patient's date of birth accuracy indicator
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
inv-01-family-name-length-not-absent | warning | Patient | Family name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331 | `Patient.name.family.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.family.matches('^.{1,40}$')`
inv-02-given-name-length-if-not-absent | warning | Patient | Given name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331 | `Patient.name.given.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.given.matches('^.{1,40}$')`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | Clinical Note Document Patient 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, inv-01-family-name-length-not-absent, inv-02-given-name-length-if-not-absent
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 |  | 2..* | 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 | 1..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
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 | 1..* | (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
extension:individualPronouns | SO C | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core 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 | S | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:informalCarer |  | 0..1 | (Complex) | Patient's informal carer information URL: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:ihi | SO Σ | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:medicare | SO Σ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
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
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
Slices for name | SO Σ C | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use 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
name:All Slices |  |  |  | Content/Rules for all slices
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
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
family | SO Σ | 1..1 | string | Patient's family 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
given | SO Σ | 0..* | string | Patient's given name 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
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
name:preferredName | SO Σ C | 0..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
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 Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core 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
family | SO Σ | 1..1 | string | Patient's family 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
given | SO Σ | 0..* | string | Patient's given name 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
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
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
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
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
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
birthDate | SO Σ C | 1..1 | date | Patient's date of birth
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:accuracyIndicator |  | 0..1 | Coding | Patient's date of birth 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
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
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
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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.name:preferredName.​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.ontoserver.csiro.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.ontoserver.csiro.au
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present | `(identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present | `name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-03 | error | Patient.name, Patient.name:preferredName | 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-01-family-name-length-not-absent | warning | Patient | Family name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331 | `Patient.name.family.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.family.matches('^.{1,40}$')`
inv-02-given-name-length-if-not-absent | warning | Patient | Given name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331 | `Patient.name.given.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.given.matches('^.{1,40}$')`
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

Mandatory: 3 elements(2 nested mandatory elements)
Must-Support: 1 element
Fixed: 1 element

Extensions

This structure refers to these extensions:

- http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Patient.name

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | Clinical Note Document Patient 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, inv-01-family-name-length-not-absent, inv-02-given-name-length-if-not-absent
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 2..* | 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 | 1..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
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 | 1..* | (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
extension:individualPronouns | SO C | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core 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 | S | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:informalCarer |  | 0..1 | (Complex) | Patient's informal carer information URL: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:ihi | SO Σ | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:medicare | SO Σ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
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
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
Slices for name | SO Σ C | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use 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
name:All Slices |  |  |  | Content/Rules for all slices
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
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
family | SO Σ | 1..1 | string | Patient's family 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
given | SO Σ | 0..* | string | Patient's given name 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
name:preferredName | SO Σ C | 0..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
use | ?!SO Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core 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
family | SO Σ | 1..1 | string | Patient's family 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
given | SO Σ | 0..* | string | Patient's given name 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
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
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
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
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
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
birthDate | SO Σ C | 1..1 | date | Patient's date of birth
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
Slices for extension |  |  |  | Content/Rules for all slices
extension:accuracyIndicator |  | 0..1 | Coding | Patient's date of birth 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
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.name:preferredName.​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.ontoserver.csiro.au
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present | `(identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present | `name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-03 | error | Patient.name, Patient.name:preferredName | 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-01-family-name-length-not-absent | warning | Patient | Family name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331 | `Patient.name.family.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.family.matches('^.{1,40}$')`
inv-02-given-name-length-if-not-absent | warning | Patient | Given name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331 | `Patient.name.given.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.given.matches('^.{1,40}$')`
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 | C | 0..* | AUCorePatient | Clinical Note Document Patient Constraints: inv-01-family-name-length-not-absent, inv-02-given-name-length-if-not-absent
extension |  | 2..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:indigenousStatus |  | 1..1 | AustralianIndigenousStatus | Indigenous status
extension:genderIdentity |  | 1..* | PGenderIdentity(5.3.0) | The individual's gender identity
extension:sexParameterForClinicalUse | S | 0..* | PatSexParameterForClinicalUse(5.3.0) | A context-specific sex parameter for clinical use
extension:informalCarer |  | 0..1 | (Complex) | Patient's informal carer information URL: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer
Slices for name |  | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use
name:All Slices |  |  |  | Content/Rules for all slices
family |  | 1..1 | string | Patient's family name
given |  | 0..* | string | Patient's given name
name:preferredName |  | 0..1 | HumanName | A name associated with the patient
use |  | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: usual
family |  | 1..1 | string | Patient's family name
birthDate |  | 1..1 | date | Patient's date of birth
Slices for extension |  |  |  | Content/Rules for all slices
extension:accuracyIndicator |  | 0..1 | DateAccuracyIndicator | Patient's date of birth accuracy indicator
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
inv-01-family-name-length-not-absent | warning | Patient | Family name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331 | `Patient.name.family.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.family.matches('^.{1,40}$')`
inv-02-given-name-length-if-not-absent | warning | Patient | Given name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331 | `Patient.name.given.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.given.matches('^.{1,40}$')`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | Clinical Note Document Patient 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, inv-01-family-name-length-not-absent, inv-02-given-name-length-if-not-absent
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 |  | 2..* | 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 | 1..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
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 | 1..* | (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
extension:individualPronouns | SO C | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core 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 | S | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:informalCarer |  | 0..1 | (Complex) | Patient's informal carer information URL: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:ihi | SO Σ | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
identifier:medicare | SO Σ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
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
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
Slices for name | SO Σ C | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use 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
name:All Slices |  |  |  | Content/Rules for all slices
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
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
family | SO Σ | 1..1 | string | Patient's family 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
given | SO Σ | 0..* | string | Patient's given name 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
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
name:preferredName | SO Σ C | 0..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
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 Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core 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
family | SO Σ | 1..1 | string | Patient's family 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
given | SO Σ | 0..* | string | Patient's given name 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
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
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
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
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
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
birthDate | SO Σ C | 1..1 | date | Patient's date of birth
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:accuracyIndicator |  | 0..1 | Coding | Patient's date of birth 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
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
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
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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Patient
SHALL:no-error | AU Core Requester | from AU Core Patient
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.name:preferredName.​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.ontoserver.csiro.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.ontoserver.csiro.au
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present | `(identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present | `name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
au-core-pat-03 | error | Patient.name, Patient.name:preferredName | 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-01-family-name-length-not-absent | warning | Patient | Family name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331 | `Patient.name.family.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.family.matches('^.{1,40}$')`
inv-02-given-name-length-if-not-absent | warning | Patient | Given name must be between 1 and 40 characters if data-absent-reason is not present, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters as per METeOR id 613331 | `Patient.name.given.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists().not() implies Patient.name.given.matches('^.{1,40}$')`
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

Mandatory: 3 elements(2 nested mandatory elements)
Must-Support: 1 element
Fixed: 1 element

Extensions

This structure refers to these extensions:

- http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/informal-carer

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Patient.name

Other representations of profile: CSV, Excel, Schematron