AU Base Implementation Guide
5.0.1-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 5.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. 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

Resource Profile: AU Base Patient

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-patient Version: 5.0.1-ci-build
Standards status: Trial-use Maturity Level: 3 Computable Name: AUBasePatient

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

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.

Usage Notes

Profile specific implementation guidance:

  • See each Identifier profile page for guidance related to that identifier type.
  • This profile supports the sex, gender, and related concepts of: Name to Use, Gender Identity, Individual Pronouns, Recorded Sex or Gender, Sex Assigned at Birth:
    • When exchanging concepts of sex or gender, refer to the guidance in Sex and Gender and the Gender Harmony Implementation Guide.
    • The Patient.gender value SHALL be regarded as a Recorded Sex or Gender (RSG) value. If assertions regarding the nature of the Patient.gender value are required, a single instance of the Person Recorded Sex or Gender extension can be included with these assertions and its genderElementQualifier subelement set to a value of “true”.
  • Need for an interpreter service can be represented with the interpreterRequired extension set to “true”
    • If the language for interpreter service is known, the language is included in Patient.communication.language and Patient.communication.preferred is set to “true”.
    • If Patient.communication.preferred has not been included, or is set to “false”, systems should understand this as the language for the interpreter service is not known.

Extensions under consideration:

Usage:

Changes since version 5.0.0:

  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed

    • Formal Views of Profile Content

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

    This structure is derived from Patient

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Patient C 0..* Patient A patient in an Australian healthcare context
    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 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 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 Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:birthPlace 0..1 Address Place of Birth for patient
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    .... extension:indigenousStatus 0..1 Coding Indigenous status
    URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
    Binding: Australian Indigenous Status . (required)
    .... extension:veteranStatus 0..* Coding Veteran / Australian Defence Force (ADF) status
    URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status
    Binding: Australian Veteran Status . (required)
    .... extension:closingTheGapRegistration 0..1 boolean Closing the Gap co-payment eligibility indicator
    URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
    .... extension:mothersMaidenName 0..1 string Mother's Maiden name
    URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
    .... extension:interpreterRequired 0..1 boolean Whether an interpreter is required
    URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
    .... extension:dateOfArrival 0..1 date The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more
    URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
    .... extension:genderIdentity C 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
    .... extension:individualPronouns C 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
    URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
    .... extension:recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply
    URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
    ... identifier 0..* Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber Identifies this patient across multiple systems
    ... birthDate C 0..1 date Date of birth extended for time and accuracy indicator
    .... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ..... extension:accuracyIndicator 0..1 Coding Birth date accuracy indicator
    URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
    Binding: Date Accuracy Indicator . (required): Date accuracy coding

    ..... extension:birthTime C 0..1 dateTime Birth time
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
    .... deceased[x]:deceasedBoolean 0..1 boolean Deceased indicator
    .... deceased[x]:deceasedDateTime 0..1 dateTime Deceased date time
    ..... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:accuracyIndicator 0..1 Coding Deceased date accuracy indicator
    URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
    Binding: Date Accuracy Indicator . (required): Date accuracy coding

    ... address 0..* AustralianAddress, Address An address for the individual
    ... contact
    .... relationship 0..* CodeableConcept The kind of relationship
    Binding: Contact Relationship Type . (extensible)
    .... address 0..1 Address, AustralianAddress Address for the contact person
    ... communication
    .... language 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)
    ... link 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual person

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Patient.contact.relationshipextensibleContactRelationshipType .
    https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3
    Patient.communication.languageextensibleCommonLanguagesInAustralia .
    https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

    Constraints

    IdGradePath(s)DetailsRequirements
    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 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 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 Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply
    : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))

     

    Other representations of profile: CSV, Excel, Schematron