AU Base Implementation Guide
7.0.0-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 7.0.0-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: 7.0.0-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, and Sex Parameter for Clinical Use:
    • 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".
  • When constructing an address:
    • an international address can be represented using the core Address data type
    • an Australian address can be represented using the Australian Address data type profile
  • See Representing Communication Preferences for guidance on how to represent languages that may be used to communicate with the patient about their health including preferred language and if an interpreter is required.

Extensions under consideration:

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed (Patient.extension:recordedSexOrGender, Patient.address)

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Patient C 0..* Patient A patient in an Australian healthcare context
    Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, inv-pat-6
    Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Patient.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for extension.extension:birthPlace 0..1 Address Place of Birth for patient
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    Patient.Slices for extension.extension:indigenousStatus 0..1 Coding Indigenous status
    URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
    Binding: Australian Indigenous Status (required)
    Patient.Slices for extension.extension:veteranStatus 0..* Coding Veteran / Australian Defence Force (ADF) status
    URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status
    Binding: Australian Veteran Status (required)
    Patient.Slices for extension.extension:closingTheGapRegistration 0..1 boolean Closing the Gap co-payment eligibility indicator
    URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
    Patient.Slices for extension.extension:mothersMaidenName 0..1 string Mother's Maiden name
    URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
    Patient.Slices for extension.extension:interpreterRequired 0..1 boolean Whether an interpreter is required
    URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
    Patient.Slices for extension.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
    Patient.Slices for extension.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
    Patient.Slices for extension.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
    Patient.Slices for extension.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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
    URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
    Patient.Slices for extension.extension:sexParameterForClinicalUse 0..* (Complex) A context-specific sex parameter for clinical use
    URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
    Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Patient.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUIHI The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUMedicareCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUDVANumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUHealthCareCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUPensionerConcessionCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUCwlthSeniorsHealthCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUMedicalRecordNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUInsuranceMemberNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUPatientInternalIdentifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Identifies this patient across multiple systems
    Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
    Patient.birthDate This element is included in summaries. C 0..1 date Date of birth extended for time and accuracy indicator
    Patient.birthDate.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.birthDate.Slices for extension.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
    Patient.birthDate.Slices for extension.extension:birthTime C 0..1 dateTime Birth time
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
    Patient.Slices for deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
    Slice: Unordered, Closed by type:$this
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for deceased[x].deceasedBoolean boolean
    Patient.Slices for deceased[x].deceasedDateTime dateTime
    Patient.Slices for deceased[x].deceased[x]:deceasedBoolean This element is a modifier element. This element is included in summaries. 0..1 boolean Deceased indicator
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime This element is a modifier element. This element is included in summaries. 0..1 dateTime Deceased date time
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension Content/Rules for all slices
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.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
    Patient.address This element is included in summaries. 0..* AustralianAddress The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, Address The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well An address for the individual
    Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual person
    Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
    Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
    Binding: LinkType (required): The type of link between this patient resource and another patient resource.

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Patient If 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-4 error Patient If 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-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-pat-0 error Patient If 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-1 warning Patient Individual 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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
    inv-pat-2 warning Patient Individual 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').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
    inv-pat-3 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
    inv-pat-4 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
    inv-pat-5 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
    inv-pat-6 warning Patient Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

    This structure is derived from Patient

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Patient C 0..* Patient A patient in an Australian healthcare context
    Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, inv-pat-6
    Patient.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for extension.extension:birthPlace 0..1 Address Place of Birth for patient
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    Patient.Slices for extension.extension:indigenousStatus 0..1 Coding Indigenous status
    URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
    Binding: Australian Indigenous Status (required)
    Patient.Slices for extension.extension:veteranStatus 0..* Coding Veteran / Australian Defence Force (ADF) status
    URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status
    Binding: Australian Veteran Status (required)
    Patient.Slices for extension.extension:closingTheGapRegistration 0..1 boolean Closing the Gap co-payment eligibility indicator
    URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
    Patient.Slices for extension.extension:mothersMaidenName 0..1 string Mother's Maiden name
    URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
    Patient.Slices for extension.extension:interpreterRequired 0..1 boolean Whether an interpreter is required
    URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
    Patient.Slices for extension.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
    Patient.Slices for extension.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
    Patient.Slices for extension.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
    Patient.Slices for extension.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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
    URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
    Patient.Slices for extension.extension:sexParameterForClinicalUse 0..* (Complex) A context-specific sex parameter for clinical use
    URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
    Patient.identifier 0..* Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier Identifies this patient across multiple systems
    Patient.birthDate C 0..1 date Date of birth extended for time and accuracy indicator
    Patient.birthDate.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.birthDate.Slices for extension.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
    Patient.birthDate.Slices for extension.extension:birthTime C 0..1 dateTime Birth time
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
    Patient.Slices for deceased[x].deceased[x]:deceasedBoolean 0..1 boolean Deceased indicator
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime 0..1 dateTime Deceased date time
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension Content/Rules for all slices
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.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
    Patient.address 0..* AustralianAddress, Address An address for the individual
    Patient.contact
    Patient.contact.relationship 0..* CodeableConcept The kind of relationship
    Binding: Contact Relationship Type (extensible)
    Patient.contact.address 0..1 Address, AustralianAddress Address for the contact person
    Patient.communication
    Patient.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)
    Patient.link 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual person

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Patient.contact.relationship Base extensible Contact Relationship Type ⏿3.1.0 tx.hl7.org.au
    Patient.communication.​language Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

    Constraints

    Id Grade Path(s) Description Expression
    inv-pat-0 error Patient If 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-1 warning Patient Individual 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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
    inv-pat-2 warning Patient Individual 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').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
    inv-pat-3 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
    inv-pat-4 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
    inv-pat-5 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
    inv-pat-6 warning Patient Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Patient C 0..* Patient A patient in an Australian healthcare context
    Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, inv-pat-6
    Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
    Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Patient.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    Patient.contained 0..* Resource Contained, inline Resources
    Patient.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for extension.extension:birthPlace 0..1 Address Place of Birth for patient
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    Patient.Slices for extension.extension:indigenousStatus 0..1 Coding Indigenous status
    URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
    Binding: Australian Indigenous Status (required)
    Patient.Slices for extension.extension:veteranStatus 0..* Coding Veteran / Australian Defence Force (ADF) status
    URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status
    Binding: Australian Veteran Status (required)
    Patient.Slices for extension.extension:closingTheGapRegistration 0..1 boolean Closing the Gap co-payment eligibility indicator
    URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
    Patient.Slices for extension.extension:mothersMaidenName 0..1 string Mother's Maiden name
    URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
    Patient.Slices for extension.extension:interpreterRequired 0..1 boolean Whether an interpreter is required
    URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
    Patient.Slices for extension.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
    Patient.Slices for extension.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
    Patient.Slices for extension.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
    Patient.Slices for extension.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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
    URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
    Patient.Slices for extension.extension:sexParameterForClinicalUse 0..* (Complex) A context-specific sex parameter for clinical use
    URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
    Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Patient.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUIHI The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUMedicareCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUDVANumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUHealthCareCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUPensionerConcessionCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUCwlthSeniorsHealthCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUMedicalRecordNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUInsuranceMemberNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUPatientInternalIdentifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Identifies this patient across multiple systems
    Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
    Patient.name This element is included in summaries. 0..* HumanName A name associated with the patient
    Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
    Patient.gender This element is included in summaries. 0..1 code male | female | other | unknown
    Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
    Patient.birthDate This element is included in summaries. C 0..1 date Date of birth extended for time and accuracy indicator
    Patient.birthDate.id 0..1 string xml:id (or equivalent in JSON)
    Patient.birthDate.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.birthDate.Slices for extension.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
    Patient.birthDate.Slices for extension.extension:birthTime C 0..1 dateTime Birth time
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
    Patient.birthDate.value 0..1 date Primitive value for date
    Patient.Slices for deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
    Slice: Unordered, Closed by type:$this
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for deceased[x].deceasedBoolean boolean
    Patient.Slices for deceased[x].deceasedDateTime dateTime
    Patient.Slices for deceased[x].deceased[x]:deceasedBoolean This element is a modifier element. This element is included in summaries. 0..1 boolean Deceased indicator
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime This element is a modifier element. This element is included in summaries. 0..1 dateTime Deceased date time
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.id 0..1 string xml:id (or equivalent in JSON)
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension Content/Rules for all slices
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.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
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.value 0..1 dateTime Primitive value for dateTime
    Patient.address This element is included in summaries. 0..* AustralianAddress The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, Address The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well An address for the individual
    Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
    Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
    Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
    Patient.multipleBirth[x].multipleBirthBoolean boolean
    Patient.multipleBirth[x].multipleBirthInteger integer
    Patient.photo 0..* Attachment Image of the patient
    Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
    Constraints: pat-1
    Patient.contact.id 0..1 string Unique id for inter-element referencing
    Patient.contact.extension 0..* Extension Additional content defined by implementations
    Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Patient.contact.relationship 0..* CodeableConcept The kind of relationship
    Binding: Contact Relationship Type (extensible)
    Patient.contact.name 0..1 HumanName A name associated with the contact person
    Patient.contact.telecom 0..* ContactPoint A contact detail for the person
    Patient.contact.address 0..1 Address The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AustralianAddress The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Address for the contact person
    Patient.contact.gender 0..1 code male | female | other | unknown
    Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
    Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
    Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
    Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
    Patient.communication.id 0..1 string Unique id for inter-element referencing
    Patient.communication.extension 0..* Extension Additional content defined by implementations
    Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Patient.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)
    Patient.communication.preferred 0..1 boolean Language preference indicator
    Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
    Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
    Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual person
    Patient.link.id 0..1 string Unique id for inter-element referencing
    Patient.link.extension 0..* Extension Additional content defined by implementations
    Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
    Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
    Binding: LinkType (required): The type of link between this patient resource and another patient resource.

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
    Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
    Patient.contact.relationship Base extensible Contact Relationship Type ⏿3.1.0 tx.hl7.org.au
    Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
    Patient.communication.​language Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au
    Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Patient If 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-4 error Patient If 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-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-pat-0 error Patient If 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-1 warning Patient Individual 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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
    inv-pat-2 warning Patient Individual 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').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
    inv-pat-3 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
    inv-pat-4 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
    inv-pat-5 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
    inv-pat-6 warning Patient Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))
    pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Patient C 0..* Patient A patient in an Australian healthcare context
    Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, inv-pat-6
    Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Patient.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for extension.extension:birthPlace 0..1 Address Place of Birth for patient
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    Patient.Slices for extension.extension:indigenousStatus 0..1 Coding Indigenous status
    URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
    Binding: Australian Indigenous Status (required)
    Patient.Slices for extension.extension:veteranStatus 0..* Coding Veteran / Australian Defence Force (ADF) status
    URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status
    Binding: Australian Veteran Status (required)
    Patient.Slices for extension.extension:closingTheGapRegistration 0..1 boolean Closing the Gap co-payment eligibility indicator
    URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
    Patient.Slices for extension.extension:mothersMaidenName 0..1 string Mother's Maiden name
    URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
    Patient.Slices for extension.extension:interpreterRequired 0..1 boolean Whether an interpreter is required
    URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
    Patient.Slices for extension.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
    Patient.Slices for extension.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
    Patient.Slices for extension.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
    Patient.Slices for extension.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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
    URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
    Patient.Slices for extension.extension:sexParameterForClinicalUse 0..* (Complex) A context-specific sex parameter for clinical use
    URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
    Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Patient.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUIHI The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUMedicareCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUDVANumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUHealthCareCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUPensionerConcessionCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUCwlthSeniorsHealthCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUMedicalRecordNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUInsuranceMemberNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUPatientInternalIdentifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Identifies this patient across multiple systems
    Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
    Patient.birthDate This element is included in summaries. C 0..1 date Date of birth extended for time and accuracy indicator
    Patient.birthDate.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.birthDate.Slices for extension.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
    Patient.birthDate.Slices for extension.extension:birthTime C 0..1 dateTime Birth time
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
    Patient.Slices for deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
    Slice: Unordered, Closed by type:$this
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for deceased[x].deceasedBoolean boolean
    Patient.Slices for deceased[x].deceasedDateTime dateTime
    Patient.Slices for deceased[x].deceased[x]:deceasedBoolean This element is a modifier element. This element is included in summaries. 0..1 boolean Deceased indicator
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime This element is a modifier element. This element is included in summaries. 0..1 dateTime Deceased date time
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension Content/Rules for all slices
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.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
    Patient.address This element is included in summaries. 0..* AustralianAddress The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, Address The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well An address for the individual
    Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual person
    Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
    Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
    Binding: LinkType (required): The type of link between this patient resource and another patient resource.

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Patient If 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-4 error Patient If 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-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-pat-0 error Patient If 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-1 warning Patient Individual 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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
    inv-pat-2 warning Patient Individual 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').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
    inv-pat-3 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
    inv-pat-4 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
    inv-pat-5 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
    inv-pat-6 warning Patient Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

    Differential View

    This structure is derived from Patient

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Patient C 0..* Patient A patient in an Australian healthcare context
    Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, inv-pat-6
    Patient.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for extension.extension:birthPlace 0..1 Address Place of Birth for patient
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    Patient.Slices for extension.extension:indigenousStatus 0..1 Coding Indigenous status
    URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
    Binding: Australian Indigenous Status (required)
    Patient.Slices for extension.extension:veteranStatus 0..* Coding Veteran / Australian Defence Force (ADF) status
    URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status
    Binding: Australian Veteran Status (required)
    Patient.Slices for extension.extension:closingTheGapRegistration 0..1 boolean Closing the Gap co-payment eligibility indicator
    URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
    Patient.Slices for extension.extension:mothersMaidenName 0..1 string Mother's Maiden name
    URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
    Patient.Slices for extension.extension:interpreterRequired 0..1 boolean Whether an interpreter is required
    URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
    Patient.Slices for extension.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
    Patient.Slices for extension.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
    Patient.Slices for extension.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
    Patient.Slices for extension.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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
    URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
    Patient.Slices for extension.extension:sexParameterForClinicalUse 0..* (Complex) A context-specific sex parameter for clinical use
    URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
    Patient.identifier 0..* Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier Identifies this patient across multiple systems
    Patient.birthDate C 0..1 date Date of birth extended for time and accuracy indicator
    Patient.birthDate.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.birthDate.Slices for extension.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
    Patient.birthDate.Slices for extension.extension:birthTime C 0..1 dateTime Birth time
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
    Patient.Slices for deceased[x] 0..1 boolean, dateTime Indicates if the individual is deceased or not
    Slice: Unordered, Closed by type:$this
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for deceased[x].deceased[x]:deceasedBoolean 0..1 boolean Deceased indicator
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime 0..1 dateTime Deceased date time
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension Content/Rules for all slices
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.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
    Patient.address 0..* AustralianAddress, Address An address for the individual
    Patient.contact
    Patient.contact.relationship 0..* CodeableConcept The kind of relationship
    Binding: Contact Relationship Type (extensible)
    Patient.contact.address 0..1 Address, AustralianAddress Address for the contact person
    Patient.communication
    Patient.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)
    Patient.link 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual person

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Patient.contact.relationship Base extensible Contact Relationship Type ⏿3.1.0 tx.hl7.org.au
    Patient.communication.​language Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

    Constraints

    Id Grade Path(s) Description Expression
    inv-pat-0 error Patient If 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-1 warning Patient Individual 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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
    inv-pat-2 warning Patient Individual 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').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
    inv-pat-3 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
    inv-pat-4 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
    inv-pat-5 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
    inv-pat-6 warning Patient Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Patient C 0..* Patient A patient in an Australian healthcare context
    Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, inv-pat-6
    Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
    Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Patient.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    Patient.contained 0..* Resource Contained, inline Resources
    Patient.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for extension.extension:birthPlace 0..1 Address Place of Birth for patient
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    Patient.Slices for extension.extension:indigenousStatus 0..1 Coding Indigenous status
    URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
    Binding: Australian Indigenous Status (required)
    Patient.Slices for extension.extension:veteranStatus 0..* Coding Veteran / Australian Defence Force (ADF) status
    URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status
    Binding: Australian Veteran Status (required)
    Patient.Slices for extension.extension:closingTheGapRegistration 0..1 boolean Closing the Gap co-payment eligibility indicator
    URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
    Patient.Slices for extension.extension:mothersMaidenName 0..1 string Mother's Maiden name
    URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
    Patient.Slices for extension.extension:interpreterRequired 0..1 boolean Whether an interpreter is required
    URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
    Patient.Slices for extension.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
    Patient.Slices for extension.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
    Patient.Slices for extension.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
    Patient.Slices for extension.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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
    URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
    Patient.Slices for extension.extension:sexParameterForClinicalUse 0..* (Complex) A context-specific sex parameter for clinical use
    URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
    Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Patient.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUIHI The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUMedicareCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUDVANumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUHealthCareCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUPensionerConcessionCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUCwlthSeniorsHealthCardNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUMedicalRecordNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUInsuranceMemberNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUPatientInternalIdentifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Identifies this patient across multiple systems
    Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
    Patient.name This element is included in summaries. 0..* HumanName A name associated with the patient
    Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
    Patient.gender This element is included in summaries. 0..1 code male | female | other | unknown
    Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
    Patient.birthDate This element is included in summaries. C 0..1 date Date of birth extended for time and accuracy indicator
    Patient.birthDate.id 0..1 string xml:id (or equivalent in JSON)
    Patient.birthDate.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.birthDate.Slices for extension.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
    Patient.birthDate.Slices for extension.extension:birthTime C 0..1 dateTime Birth time
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
    Patient.birthDate.value 0..1 date Primitive value for date
    Patient.Slices for deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
    Slice: Unordered, Closed by type:$this
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for deceased[x].deceasedBoolean boolean
    Patient.Slices for deceased[x].deceasedDateTime dateTime
    Patient.Slices for deceased[x].deceased[x]:deceasedBoolean This element is a modifier element. This element is included in summaries. 0..1 boolean Deceased indicator
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime This element is a modifier element. This element is included in summaries. 0..1 dateTime Deceased date time
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.id 0..1 string xml:id (or equivalent in JSON)
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension Content/Rules for all slices
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.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
    Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.value 0..1 dateTime Primitive value for dateTime
    Patient.address This element is included in summaries. 0..* AustralianAddress The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, Address The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well An address for the individual
    Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
    Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
    Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
    Patient.multipleBirth[x].multipleBirthBoolean boolean
    Patient.multipleBirth[x].multipleBirthInteger integer
    Patient.photo 0..* Attachment Image of the patient
    Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
    Constraints: pat-1
    Patient.contact.id 0..1 string Unique id for inter-element referencing
    Patient.contact.extension 0..* Extension Additional content defined by implementations
    Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Patient.contact.relationship 0..* CodeableConcept The kind of relationship
    Binding: Contact Relationship Type (extensible)
    Patient.contact.name 0..1 HumanName A name associated with the contact person
    Patient.contact.telecom 0..* ContactPoint A contact detail for the person
    Patient.contact.address 0..1 Address The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AustralianAddress The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Address for the contact person
    Patient.contact.gender 0..1 code male | female | other | unknown
    Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
    Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
    Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
    Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
    Patient.communication.id 0..1 string Unique id for inter-element referencing
    Patient.communication.extension 0..* Extension Additional content defined by implementations
    Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Patient.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)
    Patient.communication.preferred 0..1 boolean Language preference indicator
    Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
    Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
    Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual person
    Patient.link.id 0..1 string Unique id for inter-element referencing
    Patient.link.extension 0..* Extension Additional content defined by implementations
    Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
    Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
    Binding: LinkType (required): The type of link between this patient resource and another patient resource.

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
    Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
    Patient.contact.relationship Base extensible Contact Relationship Type ⏿3.1.0 tx.hl7.org.au
    Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
    Patient.communication.​language Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au
    Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Patient If 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-4 error Patient If 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-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-pat-0 error Patient If 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-1 warning Patient Individual 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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
    inv-pat-2 warning Patient Individual 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').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
    inv-pat-3 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
    inv-pat-4 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
    inv-pat-5 warning Patient 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 extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
    inv-pat-6 warning Patient Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))
    pat-1 error Patient.contact SHALL 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