AU Core Implementation Guide
0.4.1-preview - Preview Australia flag

This page is part of the AU Core (v0.4.1-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core Patient

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient Version: 0.4.1-preview
Standards status: Draft Maturity Level: 1 Computable Name: AUCorePatient

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 to record, search, and fetch basic demographics and other administrative information about an individual patient. It is based on the AU Base Patient profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Patient when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

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

Comparison with other national and international IGs

A resource conforming to this profile is conformant to:

  • IPA-Patient
  • Patient (IPS)
  • US Core Patient if gender identity is not exchanged. US Core includes the US Gore Gender Identity extension; AU Core requires support of the international Gender Identity extension

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.

Name to Use (NtU)​

By making name.use a Must Support data element, this profile explicitly supports representation and exchange of the Name to Use data element (as defined in the HL7 Cross Paradigm Implementation Guide: Gender Harmony - Sex and Gender Representation, Edition 1). Name to Use is represented using ‘usual’ in name.use. It should be noted that, name.period is not a Must Support data element in this version of the profile.

Pronouns​

By making Individual Pronouns extension a Must Support data element, this profile explicitly supports representation and exchange of the Pronouns data element (as defined in the HL7 Cross Paradigm Implementation Guide: Gender Harmony - Sex and Gender Representation, Edition 1). The value element of the Individual Pronouns extension is constrained in this profile to be Australian Pronouns (extensible).

Gender Identity (GI)

By making Individual Gender Identity extension a Must Support data element, this profile explicitly supports representation and exchange of the Gender Identity data element (as defined in the HL7 Cross Paradigm Implementation Guide: Gender Harmony - Sex and Gender Representation, Edition 1). The value element of the Individual Gender Identity extension is constrained in this profile to be Gender Identity Response (extensible).

Sex Assigned at Birth

Sex assigned at birth is represented using the Person Recorded Sex or Gender extension as profiled by AU Core Sex Assigned At Birth. It should be noted the Person Recorded Sex or Gender extension is not marked as Must Support in this version of the profile.

Profile specific implementation guidance

  • An individual’s IHI SHOULD be used in Patient.identifier if available, in preference to Medicare or DVA numbers
  • See the Representing communication preferences section for guidance
  • When constructing an address
    • an international address can be represented using the core Address data type
    • an Australian address SHOULD be represented using the Australian Address data type profile
  • This profile supports patient gender identity aligned to Australian Bureau of Statics Standard for Sex, Gender, Variations of Sex Characteristics and Sexual Orientation Variables, 2020 using the Individual Gender Identity extension and Gender Identity Response value set.
    • Man or male may be represented by sending the SNOMED CT code 446151000124109|Identifies as male gender|
    • Woman or female may be represented by sending the SNOMED CT code 446141000124107|Identifies as female gender|
    • Non-binary may be represented by sending the SNOMED CT code 33791000087105|Identifies as nonbinary gender|
    • [I/They] use a different term (please specify) may be represented by sending only text and no code
    • Prefer not to answer may be represented by sending the code “asked-declined”
    • Not stated or inadequately described may be represented by the code “unknown”
    • Where the workflow does not support obtaining a gender identity value, it may be represented by sending the code “not-asked”
  • This profile supports indvidual pronouns using the Individual Pronouns extension and the Australian Pronouns value set supplied as the individual pronoun value.
    • they/them/their/theirs/themselves may be represented by sending the LOINC Answer (LA) code LA29520-6
    • she/her/her/hers/herself may be represented by sending the LOINC Answer (LA) code LA29519-8
    • he/him/his/his/himself may be represented by sending the LOINC Answer (LA) code LA29518-0
    • Prefer not to answer may be represented by sending the Data Absent Reason code “asked-declined”
    • Asked but not known may be represented by sending the Data Absent Reason code “asked-unknown”
    • Not stated or inadequately described may be represented by the Data Absent Reason code “unknown”
    • Where the workflow does not support obtaining a pronoun, it may be represented by sending the Data Absent Reason code “not-asked”
    • Where a preferred pronoun is provided but is not one of the Australian Pronouns terms then a text only or alternative specific coded value can be supplied.
  • When exchanging concepts of sex or gender, refer to the guidance in the Gender Harmony Implementation Guide and AU Base Patient
  • Patient names can be provided as a text representation in name.text and/or parts such as name.family and name.given.
    • name.text specifies the entire name as it should be displayed and this may be provided instead of, or as well as, the specific parts. It is important to note that the presence of parts of a name, e.g. name.family and name.given, do not imply that name.text is known or must be supplied.
    • In this profile, the following sub-elements of name are marked as Must Support: name.use, name.text, name.family, and name.given
      • responders are required to support at least one of the following sub-elements: name.text, name.family, and name.given
      • requesters are required to all sub-elements marked Must Support: name.use, name.text, name.family, and name.given

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBasePatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* AUBasePatient A patient in the context of electronic exchange of health information
au-core-pat-01: At least one patient identifier shall be valid
au-core-pat-02: At least one patient name shall have a family name
... Slices for extension Content/Rules for all slices
.... extension:indigenousStatus SO 0..1 AustralianIndigenousStatus Indigenous status
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... extension:genderIdentity SO 0..* PGenderIdentity Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... extension:individualPronouns SO 0..* Pronouns Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... Slices for identifier SOC 1..* Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber Identifies this patient across multiple systems
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:ihi SO 0..1 AUIHI Individual Healthcare Identifier (IHI)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:medicare SO 0..1 AUMedicareCardNumber Medicare Card Number
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:dva SO 0..1 AUDVANumber Department of Veterans' Affairs (DVA) Number
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... name SOC 1..* HumanName A name associated with the patient
au-core-pat-04: At least text, family name, or given name shall be present
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... use SO 0..1 code usual | official | temp | nickname | anonymous | old | maiden
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... text SO 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... family SO 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... given SO 0..* string Given names (not always 'first'). Includes middle names
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... gender SO 1..1 code male | female | other | unknown
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... birthDate SO 1..1 date Date of birth extended for time and accuracy indicator
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... address SO 0..* AustralianAddress, Address An address for the individual
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... communication SO 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... language SO 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... preferred SO 0..1 boolean Language preference indicator
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
au-core-pat-01errorPatientAt least one patient identifier shall be valid
: identifier.where(system.count() + value.count() >1).exists()
au-core-pat-02errorPatientAt least one patient name shall have a family name
: name.family.exists()
au-core-pat-04errorPatient.nameAt least text, family name, or given name shall be present
: text.exists() or family.exists() or given.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* AUBasePatient A patient in the context of electronic exchange of health information
inv-pat-0: If present, birth time's date shall be the birth date
inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
inv-pat-3: Recorded sex or gender type shall be a member of the Common AU Recorded Sex or Gender Type value set if any codes within that value set can apply
inv-pat-4: Recorded sex or gender source document type shall be a member of the Common AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction value set if any codes within that value set can apply
au-core-pat-01: At least one patient identifier shall be valid
au-core-pat-02: At least one patient name shall have a family name
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... birthPlace 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... indigenousStatus SO 0..1 Coding Indigenous status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: Australian Indigenous Status . (required)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... veteranStatus 0..* Coding Veteran / Australian Defence Force (ADF) status
URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status
Binding: Australian Veteran Status . (required)
.... closingTheGapRegistration 0..1 boolean Closing the Gap co-payment eligibility indicator
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
.... mothersMaidenName 0..1 string Mother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
.... interpreterRequired 0..1 boolean Whether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
.... dateOfArrival 0..1 date The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more
URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
.... genderIdentity SOC 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... individualPronouns SOC 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
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the Common 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 Common 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 Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:ihi SOC 0..1 AUIHI Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:medicare SO 0..1 AUMedicareCardNumber Medicare Card Number
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:dva SO 0..1 AUDVANumber Department of Veterans' Affairs (DVA) Number
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SOΣC 1..* HumanName A name associated with the patient
au-core-pat-04: At least text, family name, or given name shall be present
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... use ?!SOΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... text SOΣ 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... family SOΣ 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... given SOΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... gender SOΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... birthDate SOΣC 1..1 date Date of birth extended for time and accuracy indicator
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... Slices for extension Content/Rules for all slices
..... accuracyIndicator 0..1 Coding Birth date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: Date Accuracy Indicator . (required): Date accuracy coding


..... birthTime C 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean Deceased indicator
.... deceased[x]:deceasedDateTime ?!Σ 0..1 dateTime Deceased date time
..... Slices for extension Content/Rules for all slices
...... accuracyIndicator 0..1 Coding Deceased date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: Date Accuracy Indicator . (required): Date accuracy coding


... address SOC 0..* AustralianAddress, Address An address for the individual
inv-add-0: The address shall at least have text or a line
inv-add-1: If asserting no fixed address, the type shall be 'physical'
inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... communication SO 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language SO 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Common Languages in Australia . (extensible)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... preferred SO 0..1 boolean Language preference indicator
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-pat-01errorPatientAt least one patient identifier shall be valid
: identifier.where(system.count() + value.count() >1).exists()
au-core-pat-02errorPatientAt least one patient name shall have a family name
: name.family.exists()
au-core-pat-04errorPatient.nameAt least text, family name, or given name shall be present
: text.exists() or family.exists() or given.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-add-0errorPatient.addressThe address shall at least have text or a line
: text.exists() or line.exists()
inv-add-1errorPatient.addressIf asserting no fixed address, the type shall be 'physical'
: extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
inv-add-2errorPatient.addressIf asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
: extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
inv-ihi-value-0errorPatient.identifier:ihiIHI shall be an exactly 16 digit number
: value.matches('^([0-9]{16})$')
inv-ihi-value-1errorPatient.identifier:ihiIHI prefix is 800360
: value.startsWith('800360')
inv-ihi-value-2errorPatient.identifier:ihiIHI shall pass the Luhn algorithm check
: (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
inv-pat-0errorPatientIf 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-1warningPatientIndividual 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-2warningPatientIndividual 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-3warningPatientRecorded sex or gender type shall be a member of the Common 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-4warningPatientRecorded sex or gender source document type shall be a member of the Common 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-5warningPatientRecorded sex or gender jurisdiction shall be a member of the Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction 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/rsg-source-document-jurisdiction'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* AUBasePatient A patient in the context of electronic exchange of health information
inv-pat-0: If present, birth time's date shall be the birth date
inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
inv-pat-3: Recorded sex or gender type shall be a member of the Common AU Recorded Sex or Gender Type value set if any codes within that value set can apply
inv-pat-4: Recorded sex or gender source document type shall be a member of the Common AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction value set if any codes within that value set can apply
au-core-pat-01: At least one patient identifier shall be valid
au-core-pat-02: At least one patient name shall have a family name
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... birthPlace 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... indigenousStatus SO 0..1 Coding Indigenous status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: Australian Indigenous Status . (required)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... veteranStatus 0..* Coding Veteran / Australian Defence Force (ADF) status
URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status
Binding: Australian Veteran Status . (required)
.... closingTheGapRegistration 0..1 boolean Closing the Gap co-payment eligibility indicator
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
.... mothersMaidenName 0..1 string Mother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
.... interpreterRequired 0..1 boolean Whether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
.... dateOfArrival 0..1 date The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more
URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
.... genderIdentity SOC 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... individualPronouns SOC 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
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the Common 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 Common 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 Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SOC 1..* Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber Identifies this patient across multiple systems
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:ihi SOC 0..1 AUIHI Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:medicare SO 0..1 AUMedicareCardNumber Medicare Card Number
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:dva SO 0..1 AUDVANumber Department of Veterans' Affairs (DVA) Number
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SOΣC 1..* HumanName A name associated with the patient
au-core-pat-04: At least text, family name, or given name shall be present
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SOΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... text SOΣ 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... family SOΣ 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... given SOΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... gender SOΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... birthDate SOΣC 1..1 date Date of birth extended for time and accuracy indicator
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... accuracyIndicator 0..1 Coding Birth date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: Date Accuracy Indicator . (required): Date accuracy coding


..... birthTime C 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1 date Primitive value for date
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean Deceased indicator
.... deceased[x]:deceasedDateTime ?!Σ 0..1 dateTime Deceased date time
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... accuracyIndicator 0..1 Coding Deceased date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: Date Accuracy Indicator . (required): Date accuracy coding


..... value 0..1 dateTime Primitive value for dateTime
... address SOC 0..* AustralianAddress, Address An address for the individual
inv-add-0: The address shall at least have text or a line
inv-add-1: If asserting no fixed address, the type shall be 'physical'
inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: Contact Relationship Type . (extensible)
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address, AustralianAddress Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication SO 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language SO 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Common Languages in Australia . (extensible)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... preferred SO 0..1 boolean Language preference indicator
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensibleContactRelationshipType .
https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-pat-01errorPatientAt least one patient identifier shall be valid
: identifier.where(system.count() + value.count() >1).exists()
au-core-pat-02errorPatientAt least one patient name shall have a family name
: name.family.exists()
au-core-pat-04errorPatient.nameAt least text, family name, or given name shall be present
: text.exists() or family.exists() or given.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-add-0errorPatient.addressThe address shall at least have text or a line
: text.exists() or line.exists()
inv-add-1errorPatient.addressIf asserting no fixed address, the type shall be 'physical'
: extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
inv-add-2errorPatient.addressIf asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
: extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
inv-ihi-value-0errorPatient.identifier:ihiIHI shall be an exactly 16 digit number
: value.matches('^([0-9]{16})$')
inv-ihi-value-1errorPatient.identifier:ihiIHI prefix is 800360
: value.startsWith('800360')
inv-ihi-value-2errorPatient.identifier:ihiIHI shall pass the Luhn algorithm check
: (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
inv-pat-0errorPatientIf 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-1warningPatientIndividual 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-2warningPatientIndividual 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-3warningPatientRecorded sex or gender type shall be a member of the Common 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-4warningPatientRecorded sex or gender source document type shall be a member of the Common 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-5warningPatientRecorded sex or gender jurisdiction shall be a member of the Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction 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/rsg-source-document-jurisdiction'))
pat-1errorPatient.contactSHALL 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 AUBasePatient

Summary

Mandatory: 4 elements
Must-Support: 19 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier

Maturity: 1

Differential View

This structure is derived from AUBasePatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* AUBasePatient A patient in the context of electronic exchange of health information
au-core-pat-01: At least one patient identifier shall be valid
au-core-pat-02: At least one patient name shall have a family name
... Slices for extension Content/Rules for all slices
.... extension:indigenousStatus SO 0..1 AustralianIndigenousStatus Indigenous status
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... extension:genderIdentity SO 0..* PGenderIdentity Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... extension:individualPronouns SO 0..* Pronouns Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... Slices for identifier SOC 1..* Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber Identifies this patient across multiple systems
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:ihi SO 0..1 AUIHI Individual Healthcare Identifier (IHI)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:medicare SO 0..1 AUMedicareCardNumber Medicare Card Number
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:dva SO 0..1 AUDVANumber Department of Veterans' Affairs (DVA) Number
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... name SOC 1..* HumanName A name associated with the patient
au-core-pat-04: At least text, family name, or given name shall be present
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... use SO 0..1 code usual | official | temp | nickname | anonymous | old | maiden
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... text SO 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... family SO 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... given SO 0..* string Given names (not always 'first'). Includes middle names
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... gender SO 1..1 code male | female | other | unknown
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... birthDate SO 1..1 date Date of birth extended for time and accuracy indicator
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... address SO 0..* AustralianAddress, Address An address for the individual
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... communication SO 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... language SO 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... preferred SO 0..1 boolean Language preference indicator
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
au-core-pat-01errorPatientAt least one patient identifier shall be valid
: identifier.where(system.count() + value.count() >1).exists()
au-core-pat-02errorPatientAt least one patient name shall have a family name
: name.family.exists()
au-core-pat-04errorPatient.nameAt least text, family name, or given name shall be present
: text.exists() or family.exists() or given.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* AUBasePatient A patient in the context of electronic exchange of health information
inv-pat-0: If present, birth time's date shall be the birth date
inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
inv-pat-3: Recorded sex or gender type shall be a member of the Common AU Recorded Sex or Gender Type value set if any codes within that value set can apply
inv-pat-4: Recorded sex or gender source document type shall be a member of the Common AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction value set if any codes within that value set can apply
au-core-pat-01: At least one patient identifier shall be valid
au-core-pat-02: At least one patient name shall have a family name
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... birthPlace 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... indigenousStatus SO 0..1 Coding Indigenous status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: Australian Indigenous Status . (required)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... veteranStatus 0..* Coding Veteran / Australian Defence Force (ADF) status
URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status
Binding: Australian Veteran Status . (required)
.... closingTheGapRegistration 0..1 boolean Closing the Gap co-payment eligibility indicator
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
.... mothersMaidenName 0..1 string Mother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
.... interpreterRequired 0..1 boolean Whether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
.... dateOfArrival 0..1 date The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more
URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
.... genderIdentity SOC 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... individualPronouns SOC 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
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the Common 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 Common 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 Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:ihi SOC 0..1 AUIHI Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:medicare SO 0..1 AUMedicareCardNumber Medicare Card Number
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:dva SO 0..1 AUDVANumber Department of Veterans' Affairs (DVA) Number
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SOΣC 1..* HumanName A name associated with the patient
au-core-pat-04: At least text, family name, or given name shall be present
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... use ?!SOΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... text SOΣ 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... family SOΣ 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... given SOΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... gender SOΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... birthDate SOΣC 1..1 date Date of birth extended for time and accuracy indicator
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... Slices for extension Content/Rules for all slices
..... accuracyIndicator 0..1 Coding Birth date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: Date Accuracy Indicator . (required): Date accuracy coding


..... birthTime C 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean Deceased indicator
.... deceased[x]:deceasedDateTime ?!Σ 0..1 dateTime Deceased date time
..... Slices for extension Content/Rules for all slices
...... accuracyIndicator 0..1 Coding Deceased date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: Date Accuracy Indicator . (required): Date accuracy coding


... address SOC 0..* AustralianAddress, Address An address for the individual
inv-add-0: The address shall at least have text or a line
inv-add-1: If asserting no fixed address, the type shall be 'physical'
inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... communication SO 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language SO 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Common Languages in Australia . (extensible)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... preferred SO 0..1 boolean Language preference indicator
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-pat-01errorPatientAt least one patient identifier shall be valid
: identifier.where(system.count() + value.count() >1).exists()
au-core-pat-02errorPatientAt least one patient name shall have a family name
: name.family.exists()
au-core-pat-04errorPatient.nameAt least text, family name, or given name shall be present
: text.exists() or family.exists() or given.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-add-0errorPatient.addressThe address shall at least have text or a line
: text.exists() or line.exists()
inv-add-1errorPatient.addressIf asserting no fixed address, the type shall be 'physical'
: extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
inv-add-2errorPatient.addressIf asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
: extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
inv-ihi-value-0errorPatient.identifier:ihiIHI shall be an exactly 16 digit number
: value.matches('^([0-9]{16})$')
inv-ihi-value-1errorPatient.identifier:ihiIHI prefix is 800360
: value.startsWith('800360')
inv-ihi-value-2errorPatient.identifier:ihiIHI shall pass the Luhn algorithm check
: (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
inv-pat-0errorPatientIf 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-1warningPatientIndividual 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-2warningPatientIndividual 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-3warningPatientRecorded sex or gender type shall be a member of the Common 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-4warningPatientRecorded sex or gender source document type shall be a member of the Common 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-5warningPatientRecorded sex or gender jurisdiction shall be a member of the Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction 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/rsg-source-document-jurisdiction'))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* AUBasePatient A patient in the context of electronic exchange of health information
inv-pat-0: If present, birth time's date shall be the birth date
inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
inv-pat-3: Recorded sex or gender type shall be a member of the Common AU Recorded Sex or Gender Type value set if any codes within that value set can apply
inv-pat-4: Recorded sex or gender source document type shall be a member of the Common AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction value set if any codes within that value set can apply
au-core-pat-01: At least one patient identifier shall be valid
au-core-pat-02: At least one patient name shall have a family name
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... birthPlace 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... indigenousStatus SO 0..1 Coding Indigenous status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: Australian Indigenous Status . (required)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... veteranStatus 0..* Coding Veteran / Australian Defence Force (ADF) status
URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status
Binding: Australian Veteran Status . (required)
.... closingTheGapRegistration 0..1 boolean Closing the Gap co-payment eligibility indicator
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
.... mothersMaidenName 0..1 string Mother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
.... interpreterRequired 0..1 boolean Whether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
.... dateOfArrival 0..1 date The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more
URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
.... genderIdentity SOC 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... individualPronouns SOC 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
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the Common 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 Common 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 Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SOC 1..* Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber Identifies this patient across multiple systems
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:ihi SOC 0..1 AUIHI Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:medicare SO 0..1 AUMedicareCardNumber Medicare Card Number
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... identifier:dva SO 0..1 AUDVANumber Department of Veterans' Affairs (DVA) Number
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SOΣC 1..* HumanName A name associated with the patient
au-core-pat-04: At least text, family name, or given name shall be present
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SOΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... text SOΣ 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... family SOΣ 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... given SOΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... gender SOΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... birthDate SOΣC 1..1 date Date of birth extended for time and accuracy indicator
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... accuracyIndicator 0..1 Coding Birth date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: Date Accuracy Indicator . (required): Date accuracy coding


..... birthTime C 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1 date Primitive value for date
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean Deceased indicator
.... deceased[x]:deceasedDateTime ?!Σ 0..1 dateTime Deceased date time
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... accuracyIndicator 0..1 Coding Deceased date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: Date Accuracy Indicator . (required): Date accuracy coding


..... value 0..1 dateTime Primitive value for dateTime
... address SOC 0..* AustralianAddress, Address An address for the individual
inv-add-0: The address shall at least have text or a line
inv-add-1: If asserting no fixed address, the type shall be 'physical'
inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: Contact Relationship Type . (extensible)
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address, AustralianAddress Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication SO 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language SO 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Common Languages in Australia . (extensible)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
.... preferred SO 0..1 boolean Language preference indicator
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensibleContactRelationshipType .
https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-pat-01errorPatientAt least one patient identifier shall be valid
: identifier.where(system.count() + value.count() >1).exists()
au-core-pat-02errorPatientAt least one patient name shall have a family name
: name.family.exists()
au-core-pat-04errorPatient.nameAt least text, family name, or given name shall be present
: text.exists() or family.exists() or given.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-add-0errorPatient.addressThe address shall at least have text or a line
: text.exists() or line.exists()
inv-add-1errorPatient.addressIf asserting no fixed address, the type shall be 'physical'
: extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
inv-add-2errorPatient.addressIf asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
: extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
inv-ihi-value-0errorPatient.identifier:ihiIHI shall be an exactly 16 digit number
: value.matches('^([0-9]{16})$')
inv-ihi-value-1errorPatient.identifier:ihiIHI prefix is 800360
: value.startsWith('800360')
inv-ihi-value-2errorPatient.identifier:ihiIHI shall pass the Luhn algorithm check
: (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
inv-pat-0errorPatientIf 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-1warningPatientIndividual 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-2warningPatientIndividual 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-3warningPatientRecorded sex or gender type shall be a member of the Common 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-4warningPatientRecorded sex or gender source document type shall be a member of the Common 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-5warningPatientRecorded sex or gender jurisdiction shall be a member of the Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction 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/rsg-source-document-jurisdiction'))
pat-1errorPatient.contactSHALL 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 AUBasePatient

Summary

Mandatory: 4 elements
Must-Support: 19 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

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

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
_id SHALL token
identifier SHALL token The requester SHALL provide both the system and code values. The responder SHALL support both.

The requester SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the profile. The responder SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the profile.
birthdate+family SHOULD date+string
birthdate+name SHOULD date+string
family SHOULD string
family+gender SHOULD string+token
gender+name SHOULD token+string
name SHOULD string
birthdate MAY date A requester SHALL provide a value precise to the day. A responder SHALL support a value precise to the day offset.
gender MAY token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both.
indigenous-status MAY token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both.
gender-identity MAY token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both.

Mandatory Search Parameters

  1. SHALL support fetching a Patient using the _id search parameter:

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

    Example:

    1. GET [base]/Patient/5678
    2. GET [base]/Patient?_id=5678

    Implementation Notes: Returns a single Patient resource (how to search by the logical id of the resource)

  2. SHALL support searching a patient by an identifier using the identifier search parameter:

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

    Example:

    1. GET [base]/Patient?identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    2. GET [base]/Patient?identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361
    3. GET [base]/Patient?identifier=http://example.org/fhir/mrn|12345

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

Optional Search Parameters:

The following search parameters and search parameter combinations SHOULD be supported:

  1. SHOULD support searching for a patient by a responder-defined search that matches any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text using the name search parameter:

    GET [base]/Patient?name=[string]

    Example:

    1. GET [base]/Patient?name=Wang
    2. GET [base]/Patient?name=Wang
  2. SHOULD support searching using the combination of the gender and name search parameters:

    GET [base]/Patient?gender={system|}[code]&name=[string]

    Example:

    1. GET [base]/Patient?name=Wang&gender=female

    Implementation Notes: Fetches a bundle of all Patient resources matching the specified gender and name (how to search by string and how to search by token)

  3. SHOULD support searching using the combination of the birthdate and family search parameters:

    GET [base]/Patient?birthdate=[date]&family=[string]

    Example:

    1. GET [base]/Patient?family=Wang&birthdate=2007-03-20

    Implementation Notes: Fetches a bundle of all Patient resources matching the specified birthdate and family (how to search by date and how to search by string)

  4. SHOULD support searching using the combination of the birthdate and name search parameters:

    GET [base]/Patient?birthdate=[date]&name=[string]

    Example:

    1. GET [base]/Patient?name=Wang&birthdate=2007-03-20

    Implementation Notes: Fetches a bundle of all Patient resources matching the specified birthdate and name (how to search by date and how to search by string)

  5. SHOULD support searching using the combination of the family and gender search parameters:

    GET [base]/Patient?family=[string]&gender={system|}[code]

    Example:

    1. GET [base]/Patient?family=Wang&gender=female

    Implementation Notes: Fetches a bundle of all Patient resources matching the specified family and gender (how to search by string and how to search by token)