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 Profile [FMM Level 3]

This profile defines a patient administration details structure that includes core localisation concepts for use in an Australian context.

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 Number, 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

Patient Sarah Simmons linked to related person Sarah Simmons

Patient with interpreter required in particular language

Patient with interpreter required and language unknown

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 administration details structure that includes core localisation concepts for use in an Australian context.

This profile builds on Patient.

This profile was published on Tue Mar 05 23:07:00 UTC 2019 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
... 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
... identifier 0..*Identifier, AUIHINumber, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsurerNumberAn identifier for this patient
... 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
.... 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
... address 0..*Address, AUBaseAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... contact
.... address 0..1Address, AUBaseAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... 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 ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-birthPlace I0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenous-status I0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
... closing-the-gap-registration I0..1booleanPatient Closing the Gap Program Eligibility Indication
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName I0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... patient-interpreterRequired I0..1booleanPatient Interpreter Required Indicator
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... date-of-arrival I0..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
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*Identifier, AUIHINumber, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsurerNumberAn identifier for this patient
... active ?!ΣI0..1booleanWhether this patient's record is in active use
... name ΣI0..*HumanNameA name associated with the patient
... telecom ΣI0..*ContactPointA contact detail for the individual
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateDate of birth extended for time and accuracy indicator
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... date-accuracy-indicator I0..1CodingBirth Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
.... patient-birthTime I0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1datePrimitive value for date
... deceased[x] ?!ΣI0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedBoolean ?!ΣI0..1booleanDeceased Indicator
.... deceased[x]:deceasedDateTime ?!ΣI0..1dateTimeDeceased Date Time
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... date-accuracy-indicator I0..1CodingDeceased Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
..... value 0..1dateTimePrimitive value for dateTime
... address I0..*Address, AUBaseAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus I0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] I0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo I0..*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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship I0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
.... name I0..1HumanNameA name associated with the contact person
.... telecom I0..*ContactPointA contact detail for the person
.... address I0..1Address, AUBaseAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication I0..*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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language I1..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 I0..1booleanLanguage preference indicator
... generalPractitioner I0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣI0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣI1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type ΣI1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

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
... 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
... identifier 0..*Identifier, AUIHINumber, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsurerNumberAn identifier for this patient
... 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
.... 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
... address 0..*Address, AUBaseAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... contact
.... address 0..1Address, AUBaseAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... 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 ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-birthPlace I0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenous-status I0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
... closing-the-gap-registration I0..1booleanPatient Closing the Gap Program Eligibility Indication
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName I0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... patient-interpreterRequired I0..1booleanPatient Interpreter Required Indicator
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... date-of-arrival I0..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
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*Identifier, AUIHINumber, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsurerNumberAn identifier for this patient
... active ?!ΣI0..1booleanWhether this patient's record is in active use
... name ΣI0..*HumanNameA name associated with the patient
... telecom ΣI0..*ContactPointA contact detail for the individual
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateDate of birth extended for time and accuracy indicator
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... date-accuracy-indicator I0..1CodingBirth Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
.... patient-birthTime I0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1datePrimitive value for date
... deceased[x] ?!ΣI0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedBoolean ?!ΣI0..1booleanDeceased Indicator
.... deceased[x]:deceasedDateTime ?!ΣI0..1dateTimeDeceased Date Time
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... date-accuracy-indicator I0..1CodingDeceased Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
..... value 0..1dateTimePrimitive value for dateTime
... address I0..*Address, AUBaseAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus I0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] I0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo I0..*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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship I0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
.... name I0..1HumanNameA name associated with the contact person
.... telecom I0..*ContactPointA contact detail for the person
.... address I0..1Address, AUBaseAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication I0..*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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language I1..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 I0..1booleanLanguage preference indicator
... generalPractitioner I0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣI0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣI1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type ΣI1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

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