AU Patient Summary Implementation Guide
0.4.0-draft - Draft

AU Patient Summary Implementation Guide - Local Development build (v0.4.0-draft) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: AU PS Patient

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient | Version: 0.4.0-draft
Standards status: Draft | Maturity Level: 0 | Computable Name: AUPSPatient
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a Patient resource in the context of a patient summary in an Australian context. It is based on the AU Core Patient profile, and applies the additional requirements from Patient (IPS).

See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.

### Profile Specific Implementation Guidance

- See the guidance on implementing the Patient resource in AU Core.
- When populating `Patient.identifier`, producers are not required to populate all known patient identifiers from the source system. Producers:
  - SHALL populate with at least one identifier
  - SHALL populate with at least one of the supported identifier types if known
  - SHOULD populate an IHI in preference to Medicare or DVA numbers where the IHI is known and MAY also provide a Medicare, DVA number, other identifier type or any combination of them
- This profile supports the sex, gender, and related concepts of: Name to Use, Gender Identity, and Individual Pronouns. See the Sex and Gender page for guidance on exchanging sex and gender related concepts conformant to AU PS.

Usages:

- Use this Profile: AU PS Bundle
- Refer to this Profile: AU PS AllergyIntolerance, AU PS Composition, AU PS Condition, AU PS Pathology Result Observation... Show 7 more, AU PS Encounter, AU PS Immunization, AU PS MedicationRequest, AU PS MedicationStatement, AU PS Procedure, AU PS RelatedPerson and AU PS Smoking Status

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.

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

This structure is derived from AUCorePatient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information This profile also complies with the profile Patient (IPS)
Slices for extension |  |  |  | Content/Rules for all slices
extension:indigenousStatus | O | 0..1 | AustralianIndigenousStatus | Indigenous status
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
extension:genderIdentity | O | 0..* | PGenderIdentity(5.3.0-ballot-tc1) | The individual's gender identity
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
extension:individualPronouns | O | 0..* | Pronouns(5.3.0-ballot-tc1) | The pronouns to use when communicating about an individual.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier | O | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:ihi | O | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:medicare | O | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:dva | O | 0..1 | AUDVANumber | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
name | O C | 1..* | HumanName | A name associated with the patient Constraints: ips-pat-1
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
use | O | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
text | O | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
family | O | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
given | O | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
telecom | O | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
system | O | 0..1 | code | phone | fax | email | pager | url | sms | other
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
value | O | 0..1 | string | The actual contact point details
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
use | O | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
gender | O | 1..1 | code | male | female | other | unknown
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
birthDate | O | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
address | O | 0..* | AustralianAddress, Address | An address for the individual
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
communication | O | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
language | O | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
preferred | O | 0..1 | boolean | Language preference indicator
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
generalPractitioner | SO | 0..* | Reference(AU PS Organization | AU PS Practitioner | AU PS PractitionerRole) | Patient's nominated primary care provider
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.exists() |

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information This profile also complies with the profile Patient (IPS) Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:birthPlace |  | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:indigenousStatus | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
extension:veteranStatus |  | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
extension:closingTheGapRegistration |  | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
extension:mothersMaidenName |  | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
extension:interpreterRequired |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension:dateOfArrival |  | 0..1 | date | The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
extension:genderIdentity | SO C | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
extension:individualPronouns | SO C | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
extension:sexParameterForClinicalUse |  | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:ihi | SO Σ | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:medicare | SO Σ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:dva | SO Σ | 0..1 | AUDVANumber | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03, ips-pat-1
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
use | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
given | SO Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
system | SO Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
value | SO Σ | 0..1 | string | The actual contact point details
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
use | ?!SO Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
gender | SO Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
birthDate | SO Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Slices for extension |  |  |  | Content/Rules for all slices
extension:accuracyIndicator |  | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
extension:birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Slices for deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time
Slices for extension |  |  |  | Content/Rules for all slices
extension:accuracyIndicator |  | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
address | SO Σ | 0..* | AustralianAddress, Address | An address for the individual
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
generalPractitioner | SO | 0..* | Reference(AU PS Organization | AU PS Practitioner | AU PS PractitionerRole) | Patient's nominated primary care provider
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` From the FHIR Standard
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.communication.language | extensible | CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` From https://tx.ontoserver.csiro.au/fhir
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-pat-0 | error | Patient | If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString() |
inv-pat-1 | warning | Patient | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) |
inv-pat-2 | warning | Patient | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) |
inv-pat-3 | warning | Patient | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) |
inv-pat-4 | warning | Patient | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) |
inv-pat-5 | warning | Patient | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.exists() |

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information This profile also complies with the profile Patient (IPS) Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:birthPlace |  | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:indigenousStatus | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
extension:veteranStatus |  | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
extension:closingTheGapRegistration |  | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
extension:mothersMaidenName |  | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
extension:interpreterRequired |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension:dateOfArrival |  | 0..1 | date | The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
extension:genderIdentity | SO C | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
extension:individualPronouns | SO C | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
extension:sexParameterForClinicalUse |  | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:ihi | SO Σ | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:medicare | SO Σ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:dva | SO Σ | 0..1 | AUDVANumber | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03, ips-pat-1
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
given | SO Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
value | SO Σ | 0..1 | string | The actual contact point details
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
use | ?!SO Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
birthDate | SO Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:accuracyIndicator |  | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
extension:birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value |  | 0..1 | date | Primitive value for date
Slices for deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:accuracyIndicator |  | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
value |  | 0..1 | dateTime | Primitive value for dateTime
address | SO Σ | 0..* | AustralianAddress, Address | An address for the individual
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
generalPractitioner | SO | 0..* | Reference(AU PS Organization | AU PS Practitioner | AU PS PractitionerRole) | Patient's nominated primary care provider
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` From the FHIR Standard
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.maritalStatus | extensible | Marital Status Codes `http://hl7.org/fhir/ValueSet/marital-status` From the FHIR Standard
Patient.contact.relationship | extensible | ContactRelationshipType `https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3` From https://tx.ontoserver.csiro.au/fhir
Patient.contact.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.communication.language | extensible | CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` From https://tx.ontoserver.csiro.au/fhir
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-pat-0 | error | Patient | If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString() |
inv-pat-1 | warning | Patient | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) |
inv-pat-2 | warning | Patient | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) |
inv-pat-3 | warning | Patient | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) |
inv-pat-4 | warning | Patient | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) |
inv-pat-5 | warning | Patient | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.exists() |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |

This structure is derived from AUCorePatient

Summary

Must-Support: 1 element

Structures

This structure refers to these other structures:

- AU PS Organization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-organization)
- AU PS Practitioner (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitioner)
- AU PS PractitionerRole (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitionerrole)

Maturity: 0

Differential View

This structure is derived from AUCorePatient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information This profile also complies with the profile Patient (IPS)
Slices for extension |  |  |  | Content/Rules for all slices
extension:indigenousStatus | O | 0..1 | AustralianIndigenousStatus | Indigenous status
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
extension:genderIdentity | O | 0..* | PGenderIdentity(5.3.0-ballot-tc1) | The individual's gender identity
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
extension:individualPronouns | O | 0..* | Pronouns(5.3.0-ballot-tc1) | The pronouns to use when communicating about an individual.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier | O | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:ihi | O | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:medicare | O | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:dva | O | 0..1 | AUDVANumber | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
name | O C | 1..* | HumanName | A name associated with the patient Constraints: ips-pat-1
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
use | O | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
text | O | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
family | O | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
given | O | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
telecom | O | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
system | O | 0..1 | code | phone | fax | email | pager | url | sms | other
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
value | O | 0..1 | string | The actual contact point details
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
use | O | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
gender | O | 1..1 | code | male | female | other | unknown
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
birthDate | O | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
address | O | 0..* | AustralianAddress, Address | An address for the individual
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
communication | O | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
language | O | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
preferred | O | 0..1 | boolean | Language preference indicator
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
generalPractitioner | SO | 0..* | Reference(AU PS Organization | AU PS Practitioner | AU PS PractitionerRole) | Patient's nominated primary care provider
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.exists() |

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information This profile also complies with the profile Patient (IPS) Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:birthPlace |  | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:indigenousStatus | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
extension:veteranStatus |  | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
extension:closingTheGapRegistration |  | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
extension:mothersMaidenName |  | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
extension:interpreterRequired |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension:dateOfArrival |  | 0..1 | date | The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
extension:genderIdentity | SO C | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
extension:individualPronouns | SO C | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
extension:sexParameterForClinicalUse |  | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:ihi | SO Σ | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:medicare | SO Σ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:dva | SO Σ | 0..1 | AUDVANumber | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03, ips-pat-1
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
use | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
given | SO Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
system | SO Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
value | SO Σ | 0..1 | string | The actual contact point details
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
use | ?!SO Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
gender | SO Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
birthDate | SO Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Slices for extension |  |  |  | Content/Rules for all slices
extension:accuracyIndicator |  | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
extension:birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Slices for deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time
Slices for extension |  |  |  | Content/Rules for all slices
extension:accuracyIndicator |  | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
address | SO Σ | 0..* | AustralianAddress, Address | An address for the individual
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
generalPractitioner | SO | 0..* | Reference(AU PS Organization | AU PS Practitioner | AU PS PractitionerRole) | Patient's nominated primary care provider
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` From the FHIR Standard
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.communication.language | extensible | CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` From https://tx.ontoserver.csiro.au/fhir
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-pat-0 | error | Patient | If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString() |
inv-pat-1 | warning | Patient | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) |
inv-pat-2 | warning | Patient | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) |
inv-pat-3 | warning | Patient | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) |
inv-pat-4 | warning | Patient | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) |
inv-pat-5 | warning | Patient | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information This profile also complies with the profile Patient (IPS) Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:birthPlace |  | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:indigenousStatus | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
extension:veteranStatus |  | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
extension:closingTheGapRegistration |  | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
extension:mothersMaidenName |  | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
extension:interpreterRequired |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension:dateOfArrival |  | 0..1 | date | The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
extension:genderIdentity | SO C | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
extension:individualPronouns | SO C | 0..* | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
extension:sexParameterForClinicalUse |  | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ C | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:ihi | SO Σ | 0..1 | AUIHI | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:medicare | SO Σ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
identifier:dva | SO Σ | 0..1 | AUDVANumber | Identifies this patient across multiple systems
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | SO Σ C | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03, ips-pat-1
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!SO Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
text | SO Σ | 0..1 | string | Text representation of the full name
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
family | SO Σ | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
given | SO Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | SO Σ | 0..* | ContactPoint | A contact detail for the individual
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
value | SO Σ | 0..1 | string | The actual contact point details
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
use | ?!SO Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
birthDate | SO Σ C | 1..1 | date | Date of birth extended for time and accuracy indicator
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:accuracyIndicator |  | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
extension:birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value |  | 0..1 | date | Primitive value for date
Slices for deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:accuracyIndicator |  | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
value |  | 0..1 | dateTime | Primitive value for dateTime
address | SO Σ | 0..* | AustralianAddress, Address | An address for the individual
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
preferred | SO | 0..1 | boolean | Language preference indicator
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
generalPractitioner | SO | 0..* | Reference(AU PS Organization | AU PS Practitioner | AU PS PractitionerRole) | Patient's nominated primary care provider
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` From the FHIR Standard
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.maritalStatus | extensible | Marital Status Codes `http://hl7.org/fhir/ValueSet/marital-status` From the FHIR Standard
Patient.contact.relationship | extensible | ContactRelationshipType `https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3` From https://tx.ontoserver.csiro.au/fhir
Patient.contact.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.communication.language | extensible | CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` From https://tx.ontoserver.csiro.au/fhir
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-pat-0 | error | Patient | If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString() |
inv-pat-1 | warning | Patient | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) |
inv-pat-2 | warning | Patient | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) |
inv-pat-3 | warning | Patient | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) |
inv-pat-4 | warning | Patient | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) |
inv-pat-5 | warning | Patient | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.exists() |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |

This structure is derived from AUCorePatient

Summary

Must-Support: 1 element

Structures

This structure refers to these other structures:

- AU PS Organization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-organization)
- AU PS Practitioner (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitioner)
- AU PS PractitionerRole (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitionerrole)

Maturity: 0

Other representations of profile: CSV, Excel, Schematron