Australian Base Implementation Guide (AU Base 2)

AU Base Implementation Guide, published by HL7 Australia. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

1.0 StructureDefinition-au-patient

AU Base Patient [FMM Level 3]

This profile defines a patient structure that localises core concepts, including identifiers and terminology, for use in an Australian context.

The purpose of this profile is to provide national level agreement on core localised concepts.

This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Identifiers

These definitions, defined as profiles of Identifier, represent common data held in the Patient.identifier element:

Extensions

Extensions used in this profile:

Usage Notes

Mutiple Individual Healthcare Identifiers are supported particularly to support the recording of IHI values where the status and/or record status varies (e.g. deceased, provisional).

Medicare Number is defined as a 10 or 11 digit number. Whilst 10 digits is not sufficient to uniquely identify an individual it is a supported entry where systems do not support 11 digit content. If required profiles can constrain this slice further to restrict usage to 11 digits only as desired. Medicare Numbers are not used for uniquely identifying patients, they are identifying information that can be used in conjunction with other elements such as name and date of birth appropriately to confirm identity.

To indicate an interpreter service is required, extension interpreter required=true should be set. If the language for interpreter service is known then it should be included in communication.language with communication.preferred=true. If communication.preferred=true is not set when interpreter required=true then it may be understood that an interpreter is required but the language for the interpreter service is not known.

Examples

Patient with IHI, medicare card, and Health Care Card

Patient with IHI and DVA Number

Patient with no birth date, and eligible for Closing the Gap registration

Patient with BirthTime

Patient born in 2008, with gender identity and ethnicity

Patient Sarah Simmons linked to related person Sarah Simmons, with mother’s maiden name

Patient with interpreter required in particular language

Patient with interpreter required, language unknown and date of arrival

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/StructureDefinition/au-patient

This profile defines a patient structure that localises core concepts, including identifiers and terminology, for use in an Australian context.

This profile builds on Patient.

This profile was published on Fri Mar 06 00:00:00 UTC 2020 as a active by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*PatientA patient in an Australian healthcare context
inv-pat-0: If there is a birth time its date shall be the birth date
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-birthPlace 0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenous-status 0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required): Indigenous Status

... closing-the-gap-registration 0..1booleanPatient Closing the Gap Program Eligibility Indication
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName 0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... patient-interpreterRequired 0..1booleanPatient Interpreter Required Indicator
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... date-of-arrival 0..1dateThe 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
... ethnicity 0..*CodeableConceptEthnicity
URL: http://hl7.org.au/fhir/StructureDefinition/ethnicity
... patient-genderIdentity 0..1CodeableConceptThe patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
... identifier 0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsurerNumberIdentifies this patient across multiple systems
... birthDate 0..1dateDate of birth extended for time and accuracy indicator
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... date-accuracy-indicator 0..1CodingBirth Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding

.... patient-birthTime 0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... deceased[x] 0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedBoolean 0..1booleanDeceased Indicator
.... deceased[x]:deceasedDateTime 0..1dateTimeDeceased Date Time
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... date-accuracy-indicator 0..1CodingDeceased Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding

... address 0..*AustralianAddress, AddressAn address in Australia for use within an Australian healthcare context
... contact
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible)
.... address 0..1Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... communication
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*PatientA patient in an Australian healthcare context
inv-pat-0: If there is a birth time its date shall be the birth date
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-birthPlace 0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenous-status 0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required): Indigenous Status


... closing-the-gap-registration 0..1booleanPatient Closing the Gap Program Eligibility Indication
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName 0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... patient-interpreterRequired 0..1booleanPatient Interpreter Required Indicator
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... date-of-arrival 0..1dateThe 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
... ethnicity 0..*CodeableConceptEthnicity
URL: http://hl7.org.au/fhir/StructureDefinition/ethnicity
... patient-genderIdentity 0..1CodeableConceptThe patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsurerNumberIdentifies this patient across multiple systems
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ0..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateDate of birth extended for time and accuracy indicator
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... date-accuracy-indicator 0..1CodingBirth Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding


.... patient-birthTime 0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1datePrimitive value for date
... deceased[x] ?!Σ0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedBoolean ?!Σ0..1booleanDeceased Indicator
.... deceased[x]:deceasedDateTime ?!Σ0..1dateTimeDeceased Date Time
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... date-accuracy-indicator 0..1CodingDeceased Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding


..... value 0..1dateTimePrimitive value for dateTime
... address I0..*AustralianAddress, AddressAn address in Australia for use within an Australian healthcare context
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*PatientA patient in an Australian healthcare context
inv-pat-0: If there is a birth time its date shall be the birth date
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-birthPlace 0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenous-status 0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required): Indigenous Status

... closing-the-gap-registration 0..1booleanPatient Closing the Gap Program Eligibility Indication
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName 0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... patient-interpreterRequired 0..1booleanPatient Interpreter Required Indicator
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... date-of-arrival 0..1dateThe 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
... ethnicity 0..*CodeableConceptEthnicity
URL: http://hl7.org.au/fhir/StructureDefinition/ethnicity
... patient-genderIdentity 0..1CodeableConceptThe patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
... identifier 0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsurerNumberIdentifies this patient across multiple systems
... birthDate 0..1dateDate of birth extended for time and accuracy indicator
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... date-accuracy-indicator 0..1CodingBirth Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding

.... patient-birthTime 0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... deceased[x] 0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedBoolean 0..1booleanDeceased Indicator
.... deceased[x]:deceasedDateTime 0..1dateTimeDeceased Date Time
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... date-accuracy-indicator 0..1CodingDeceased Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding

... address 0..*AustralianAddress, AddressAn address in Australia for use within an Australian healthcare context
... contact
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible)
.... address 0..1Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... communication
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*PatientA patient in an Australian healthcare context
inv-pat-0: If there is a birth time its date shall be the birth date
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-birthPlace 0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenous-status 0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required): Indigenous Status


... closing-the-gap-registration 0..1booleanPatient Closing the Gap Program Eligibility Indication
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName 0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... patient-interpreterRequired 0..1booleanPatient Interpreter Required Indicator
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... date-of-arrival 0..1dateThe 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
... ethnicity 0..*CodeableConceptEthnicity
URL: http://hl7.org.au/fhir/StructureDefinition/ethnicity
... patient-genderIdentity 0..1CodeableConceptThe patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsurerNumberIdentifies this patient across multiple systems
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ0..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateDate of birth extended for time and accuracy indicator
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... date-accuracy-indicator 0..1CodingBirth Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding


.... patient-birthTime 0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1datePrimitive value for date
... deceased[x] ?!Σ0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedBoolean ?!Σ0..1booleanDeceased Indicator
.... deceased[x]:deceasedDateTime ?!Σ0..1dateTimeDeceased Date Time
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... date-accuracy-indicator 0..1CodingDeceased Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding


..... value 0..1dateTimePrimitive value for dateTime
... address I0..*AustralianAddress, AddressAn address in Australia for use within an Australian healthcare context
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-patient

none defined