AU Base Implementation Guide
4.1.1-preview - Preview Australia flag

This page is part of the AU Base Implementation Guide 4.1.1-preview based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Base Patient

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-patient Version: 4.1.1-preview
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.

We have introduced support for the following extensions: Individual Pronouns and Person Recorded Sex Or Gender. These extensions are published in this guide to pre-adopt the material published in the R5 FHIR Extensions Pack. These extensions are an R4 (4.0.1) conversion of the canonical extension and may contain forwards incompatible data types when converted to R4 (see the extension page in this guide for information on any material differences). Implementers are advised to take note that this content may be removed or changed and to take caution if using these extensions.

Usage Notes

Profile specific implementation guidance:

  • 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 genderIdentity 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|, see example Patient/example4
    • [I/They] use a different term (please specify) may be represented by sending only text and no code, see example Patient/example7
    • Prefer not to answer may be represented by sending the code “asked-declined”, see example Patient/example0
    • Not stated or inadequately described may be represented by the code “unknown”
  • When exchanging concepts of sex or gender, refer to the guidance in the Gender Harmony Implementation Guide.
  • 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.
  • See each Identifier profile page for guidance related to that identifier type.

Extensions under consideration:

Usage:

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 C0..*PatientA patient in an Australian healthcare context
inv-pat-0: If present, birth time's date shall be the birth date
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenousStatus 0..1CodingIndigenous status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
... mothersMaidenName 0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... interpreterRequired 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... dateOfArrival 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
... genderIdentity 0..1CodeableConceptThe patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible)
... individualPronouns 0..*(Complex)The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... recordedSexOrGender 0..*(Complex)A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... identifier 0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberIdentifies this patient across multiple systems
... birthDate C0..1dateDate of birth extended for time and accuracy indicator
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... accuracyIndicator 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

.... birthTime C0..1dateTimeBirth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... Slices for deceased[x] 0..1boolean, dateTimeIndicates 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
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... accuracyIndicator 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 for the individual
... contact
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible)
.... address 0..1Address, AustralianAddressAddress for the contact person
... 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)
... link 0..*BackboneElementLink to a Patient or RelatedPerson resource that concerns the same actual person

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Patient.extension:genderIdentity.valueCodeableConceptextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1
Patient.contact.relationshipextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3
Patient.communication.languageextensiblehttps://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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*PatientA patient in an Australian healthcare context
inv-pat-0: If present, birth time's date shall be the birth date
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... closingTheGapRegistration 0..1booleanClosing the Gap co-payment eligibility indicator
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... mothersMaidenName 0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... interpreterRequired 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... dateOfArrival 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
... genderIdentity 0..1CodeableConceptThe patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
Binding: GenderIdentity (example)
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible)
... individualPronouns 0..*(Complex)The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... recordedSexOrGender 0..*(Complex)A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberIdentifies this patient across multiple systems
... active ?!Σ0..1booleanWhether this patient's record is in active use
... birthDate ΣC0..1dateDate of birth extended for time and accuracy indicator
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... accuracyIndicator 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


.... birthTime C0..1dateTimeBirth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... Slices for deceased[x] ?!Σ0..1Indicates 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
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... accuracyIndicator 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 C0..*AustralianAddress, AddressAn address for the individual
... link ?!Σ0..*BackboneElementLink to a Patient or RelatedPerson resource that concerns the same actual person
.... 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

Terminology Bindings

PathConformanceValueSet
Patient.extension:genderIdentity.value[x]exampleGenderIdentity
Patient.extension:genderIdentity.value[x]:valueCodeableConceptextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
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-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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*PatientA patient in an Australian healthcare context
inv-pat-0: If present, birth time's date shall be the birth date
... id Σ0..1idLogical 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenousStatus 0..1CodingIndigenous status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
... closingTheGapRegistration 0..1booleanClosing the Gap co-payment eligibility indicator
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... mothersMaidenName 0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... interpreterRequired 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... dateOfArrival 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
... genderIdentity 0..1CodeableConceptThe patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
Binding: GenderIdentity (example)
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible)
... individualPronouns 0..*(Complex)The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... recordedSexOrGender 0..*(Complex)A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberIdentifies 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 ΣC0..1dateDate of birth extended for time and accuracy indicator
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... accuracyIndicator 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


.... birthTime C0..1dateTimeBirth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1datePrimitive value for date
... Slices for deceased[x] ?!Σ0..1Indicates 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)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... accuracyIndicator 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 C0..*AustralianAddress, AddressAn address for the individual
... 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 C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... 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, AustralianAddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..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 a Patient or RelatedPerson 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

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.extension:genderIdentity.value[x]exampleGenderIdentity
Patient.extension:genderIdentity.value[x]:valueCodeableConceptextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusextensibleMarital Status Codes
Patient.contact.relationshipextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languageextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
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')
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()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*PatientA patient in an Australian healthcare context
inv-pat-0: If present, birth time's date shall be the birth date
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenousStatus 0..1CodingIndigenous status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
... mothersMaidenName 0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... interpreterRequired 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... dateOfArrival 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
... genderIdentity 0..1CodeableConceptThe patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible)
... individualPronouns 0..*(Complex)The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... recordedSexOrGender 0..*(Complex)A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... identifier 0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberIdentifies this patient across multiple systems
... birthDate C0..1dateDate of birth extended for time and accuracy indicator
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... accuracyIndicator 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

.... birthTime C0..1dateTimeBirth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... Slices for deceased[x] 0..1boolean, dateTimeIndicates 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
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... accuracyIndicator 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 for the individual
... contact
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible)
.... address 0..1Address, AustralianAddressAddress for the contact person
... 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)
... link 0..*BackboneElementLink to a Patient or RelatedPerson resource that concerns the same actual person

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Patient.extension:genderIdentity.valueCodeableConceptextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1
Patient.contact.relationshipextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3
Patient.communication.languageextensiblehttps://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()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*PatientA patient in an Australian healthcare context
inv-pat-0: If present, birth time's date shall be the birth date
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... closingTheGapRegistration 0..1booleanClosing the Gap co-payment eligibility indicator
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... mothersMaidenName 0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... interpreterRequired 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... dateOfArrival 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
... genderIdentity 0..1CodeableConceptThe patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
Binding: GenderIdentity (example)
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible)
... individualPronouns 0..*(Complex)The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... recordedSexOrGender 0..*(Complex)A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberIdentifies this patient across multiple systems
... active ?!Σ0..1booleanWhether this patient's record is in active use
... birthDate ΣC0..1dateDate of birth extended for time and accuracy indicator
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... accuracyIndicator 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


.... birthTime C0..1dateTimeBirth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... Slices for deceased[x] ?!Σ0..1Indicates 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
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... accuracyIndicator 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 C0..*AustralianAddress, AddressAn address for the individual
... link ?!Σ0..*BackboneElementLink to a Patient or RelatedPerson resource that concerns the same actual person
.... 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

Terminology Bindings

PathConformanceValueSet
Patient.extension:genderIdentity.value[x]exampleGenderIdentity
Patient.extension:genderIdentity.value[x]:valueCodeableConceptextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
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-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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*PatientA patient in an Australian healthcare context
inv-pat-0: If present, birth time's date shall be the birth date
... id Σ0..1idLogical 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenousStatus 0..1CodingIndigenous status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
... closingTheGapRegistration 0..1booleanClosing the Gap co-payment eligibility indicator
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... mothersMaidenName 0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... interpreterRequired 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... dateOfArrival 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
... genderIdentity 0..1CodeableConceptThe patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
Binding: GenderIdentity (example)
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible)
... individualPronouns 0..*(Complex)The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... recordedSexOrGender 0..*(Complex)A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberIdentifies 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 ΣC0..1dateDate of birth extended for time and accuracy indicator
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... accuracyIndicator 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


.... birthTime C0..1dateTimeBirth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1datePrimitive value for date
... Slices for deceased[x] ?!Σ0..1Indicates 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)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... accuracyIndicator 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 C0..*AustralianAddress, AddressAn address for the individual
... 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 C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... 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, AustralianAddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..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 a Patient or RelatedPerson 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

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.extension:genderIdentity.value[x]exampleGenderIdentity
Patient.extension:genderIdentity.value[x]:valueCodeableConceptextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusextensibleMarital Status Codes
Patient.contact.relationshipextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languageextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
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')
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()

 

Other representations of profile: CSV, Excel, Schematron