AU Core Implementation Guide
2.0.0-ci-build - CI Build
AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 2.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-core/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient | Version: 2.0.0-ci-build | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUCorePatient | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
This profile sets minimum expectations for a Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It is based on the AU Base Patient profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Patient when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.
The following are supported usage scenarios for this profile:
Patient.identifier
, responders are not required to populate all known patient identifiers from the source system. Responders:
name.text
and/or parts such as name.family
and name.given
.name.text
specifies the entire name as it is intended to be displayed. This may be provided instead of, or as well as, the specific parts. It is important to note that the presence of parts of a name, e.g. name.family
and name.given
, do not imply that name.text
is known or needs to be supplied.name
are marked as Must Support: name.use
, name.text
, name.family
, and name.given
name.text
, name.family
, and name.given
name.use
, name.text
, name.family
, and name.given
Usages:
Changes since version 1.0.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBasePatient | A patient in the context of electronic exchange of health information Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02 | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status ![]()
| ||||||
![]() ![]() ![]() ![]() |
0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status ![]() | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||||
![]() ![]() ![]() ![]() |
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 | |||||||
![]() ![]() ![]() ![]() |
SOC | 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
| ||||||
![]() ![]() ![]() ![]() |
SOC | 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
| ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
SOΣC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | AUIHI | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | AUDVANumber | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
![]() ![]() ![]() |
SOΣC | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03
| ||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
![]() ![]() ![]() |
SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||
![]() ![]() ![]() ![]() |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | The actual contact point details
| ||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
| ||||||
![]() ![]() ![]() |
SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
![]() ![]() ![]() |
SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Deceased indicator | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Deceased date time | ||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() |
SOΣ | 0..* | AustralianAddress, Address | An address for the individual
| ||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
| ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia ![]()
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | boolean | Language preference indicator
| ||||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
![]() |
Path | Conformance | ValueSet | URI |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard | |
Patient.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard | |
Patient.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard | |
Patient.communication.language | extensible | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
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').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-pat-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').all(extension('value').value.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').all(extension('type').value.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').all(extension('sourceDocument').value.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').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
This structure is derived from AUBasePatient
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBasePatient | A patient in the context of electronic exchange of health information Constraints: au-core-pat-01, au-core-pat-02 | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AustralianIndigenousStatus | Indigenous status
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..* | PGenderIdentity | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..* | Pronouns | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
| ||||||
![]() ![]() ![]() |
SOC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AUIHI | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AUDVANumber | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() |
SOC | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..* | string | Given names (not always 'first'). Includes middle names
| ||||||
![]() ![]() ![]() |
SO | 0..* | ContactPoint | A contact detail for the individual
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | code | phone | fax | email | pager | url | sms | other
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | string | The actual contact point details
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point
| ||||||
![]() ![]() ![]() |
SO | 1..1 | code | male | female | other | unknown
| ||||||
![]() ![]() ![]() |
SO | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
![]() ![]() ![]() |
SO | 0..* | AustralianAddress, Address | An address for the individual
| ||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
| ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | boolean | Language preference indicator
| ||||||
![]() |
Id | Grade | Path(s) | Details | Requirements |
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBasePatient | A patient in the context of electronic exchange of health information Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02 | ||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() ![]() |
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 | |||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status ![]()
| ||||||
![]() ![]() ![]() ![]() |
0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status ![]() | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||||
![]() ![]() ![]() ![]() |
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 | |||||||
![]() ![]() ![]() ![]() |
SOC | 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
| ||||||
![]() ![]() ![]() ![]() |
SOC | 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
| ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
SOΣC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | AUIHI | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | AUDVANumber | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
![]() ![]() ![]() |
SOΣC | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||||
![]() ![]() ![]() |
SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | The actual contact point details
| ||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||
![]() ![]() ![]() |
SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
![]() ![]() ![]() |
SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
![]() ![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||||
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Deceased indicator | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Deceased date time | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Primitive value for dateTime | |||||||
![]() ![]() ![]() |
SOΣ | 0..* | AustralianAddress, Address | An address for the individual
| ||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||
![]() ![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() ![]() |
integer | |||||||||
![]() ![]() ![]() |
0..* | Attachment | Image of the patient | |||||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type ![]() | |||||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||||
![]() ![]() ![]() ![]() |
0..1 | Address, AustralianAddress | Address for the contact person | |||||||
![]() ![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||||
![]() ![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia ![]()
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | boolean | Language preference indicator
| ||||||
![]() ![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
![]() |
Path | Conformance | ValueSet | URI | |||
Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard | ||||
Patient.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard | ||||
Patient.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard | ||||
Patient.contact.relationship | extensible | ContactRelationshipType ![]() https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard | ||||
Patient.communication.language | extensible | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
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').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-pat-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').all(extension('value').value.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').all(extension('type').value.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').all(extension('sourceDocument').value.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').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) | |
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() |
This structure is derived from AUBasePatient
Summary
Mandatory: 4 elements
Must-Support: 22 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBasePatient | A patient in the context of electronic exchange of health information Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02 | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status ![]()
| ||||||
![]() ![]() ![]() ![]() |
0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status ![]() | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||||
![]() ![]() ![]() ![]() |
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 | |||||||
![]() ![]() ![]() ![]() |
SOC | 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
| ||||||
![]() ![]() ![]() ![]() |
SOC | 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
| ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
SOΣC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | AUIHI | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | AUDVANumber | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
![]() ![]() ![]() |
SOΣC | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03
| ||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
![]() ![]() ![]() |
SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||
![]() ![]() ![]() ![]() |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | The actual contact point details
| ||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
| ||||||
![]() ![]() ![]() |
SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
![]() ![]() ![]() |
SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Deceased indicator | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Deceased date time | ||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() |
SOΣ | 0..* | AustralianAddress, Address | An address for the individual
| ||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
| ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia ![]()
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | boolean | Language preference indicator
| ||||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
![]() |
Path | Conformance | ValueSet | URI |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard | |
Patient.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard | |
Patient.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard | |
Patient.communication.language | extensible | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
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').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-pat-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').all(extension('value').value.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').all(extension('type').value.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').all(extension('sourceDocument').value.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').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
Differential View
This structure is derived from AUBasePatient
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBasePatient | A patient in the context of electronic exchange of health information Constraints: au-core-pat-01, au-core-pat-02 | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AustralianIndigenousStatus | Indigenous status
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..* | PGenderIdentity | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..* | Pronouns | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
| ||||||
![]() ![]() ![]() |
SOC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AUIHI | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AUDVANumber | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() |
SOC | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..* | string | Given names (not always 'first'). Includes middle names
| ||||||
![]() ![]() ![]() |
SO | 0..* | ContactPoint | A contact detail for the individual
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | code | phone | fax | email | pager | url | sms | other
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | string | The actual contact point details
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point
| ||||||
![]() ![]() ![]() |
SO | 1..1 | code | male | female | other | unknown
| ||||||
![]() ![]() ![]() |
SO | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
![]() ![]() ![]() |
SO | 0..* | AustralianAddress, Address | An address for the individual
| ||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
| ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | boolean | Language preference indicator
| ||||||
![]() |
Id | Grade | Path(s) | Details | Requirements |
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBasePatient | A patient in the context of electronic exchange of health information Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02 | ||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() ![]() |
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 | |||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status ![]()
| ||||||
![]() ![]() ![]() ![]() |
0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status ![]() | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||||
![]() ![]() ![]() ![]() |
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 | |||||||
![]() ![]() ![]() ![]() |
SOC | 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
| ||||||
![]() ![]() ![]() ![]() |
SOC | 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
| ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
SOΣC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | AUIHI | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | AUMedicareCardNumber | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | AUDVANumber | Identifies this patient across multiple systems
| ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
![]() ![]() ![]() |
SOΣC | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-03
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||||
![]() ![]() ![]() |
SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | The actual contact point details
| ||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||
![]() ![]() ![]() |
SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
![]() ![]() ![]() |
SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
![]() ![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||||
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Deceased indicator | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Deceased date time | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Primitive value for dateTime | |||||||
![]() ![]() ![]() |
SOΣ | 0..* | AustralianAddress, Address | An address for the individual
| ||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||
![]() ![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() ![]() |
integer | |||||||||
![]() ![]() ![]() |
0..* | Attachment | Image of the patient | |||||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type ![]() | |||||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||||
![]() ![]() ![]() ![]() |
0..1 | Address, AustralianAddress | Address for the contact person | |||||||
![]() ![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||||
![]() ![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia ![]()
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | boolean | Language preference indicator
| ||||||
![]() ![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
![]() |
Path | Conformance | ValueSet | URI | |||
Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard | ||||
Patient.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard | ||||
Patient.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard | ||||
Patient.contact.relationship | extensible | ContactRelationshipType ![]() https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard | ||||
Patient.communication.language | extensible | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-03 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
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').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-pat-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').all(extension('value').value.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').all(extension('type').value.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').all(extension('sourceDocument').value.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').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) | |
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() |
This structure is derived from AUBasePatient
Summary
Mandatory: 4 elements
Must-Support: 22 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.
FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.
Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in this implementation guide to highlight their potential relevance.
Note: Support for _id is mandatory for a responder and optional for a requester. Where the expectation for a search parameter differs between actors, the table below will reflect the stronger conformance requirement.
Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
---|---|---|---|
_id | SHALL | token |
|
identifier | SHALL | token |
The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the profile. The responder SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the profile. |
birthdate+family | SHOULD | date +string |
|
birthdate+name | SHOULD | date +string |
|
family | SHOULD | string |
|
family+gender | SHOULD | string +token |
|
gender+name | SHOULD | token +string |
|
name | SHOULD | string |
|
birthdate | MAY | date |
A requester SHALL provide a value precise to the day. A responder SHALL support a value precise to the day. The requester SHOULD support these search comparators gt , lt , ge , le . The responder SHOULD support these search comparators gt , lt , ge , le .The requester SHOULD support multipleAnd , and if multipleAnd is supported, SHALL support the search comparators gt , lt , ge , le . The responder SHOULD support multipleAnd , and if multipleAnd is supported, SHALL support the search comparators gt , lt , ge , le . |
gender | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
indigenous-status | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
gender-identity | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
The following search parameters SHALL be supported:
SHALL support searching using the _id
search parameter:
GET [base]/Patient?_id=[id]
Example:
Implementation Notes: Fetches a bundle with the requested Patient, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource).
SHALL support searching using the identifier
search parameter:
GET [base]/Patient?identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle containing all Patient resources matching the identifier (how to search by token)
The following search parameters and search parameter combinations SHOULD be supported:
SHOULD support searching by a responder-defined search that matches any string field in HumanName, including family, given, prefix, suffix, and/or text using the name
search parameter:
GET [base]/Patient?name=[string]
Example:
SHOULD support searching using the combination of the gender
and name
search parameters:
GET [base]/Patient?gender={system|}[code]&name=[string]
Example:
Implementation Notes: Fetches a bundle of all Patient resources matching the specified gender and name (how to search by string and how to search by token)
birthdate
and family
search parameters:
date
comparators: gt,lt,ge,le
date
(e.g.date=[date]&date=[date]]&...
), and if multipleAnd is supported, SHALL support the search comparators gt,lt,ge,le
GET [base]/Patient?birthdate=[date]&family=[string]
Example:
Implementation Notes: Fetches a bundle of all Patient resources matching the specified birthdate and family (how to search by date and how to search by string)
birthdate
and name
search parameters:
date
comparators: gt,lt,ge,le
date
(e.g.date=[date]&date=[date]]&...
) and if multipleAnd, and if *multipleAnd is supported, SHALL support the search comparators gt,lt,ge,le
GET [base]/Patient?birthdate=[date]&name=[string]
Example:
Implementation Notes: Fetches a bundle of all Patient resources matching the name and a birthdate greater than that specified (how to search by date and how to search by string)
SHOULD support searching using the combination of the family
and gender
search parameters:
GET [base]/Patient?family=[string]&gender={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all Patient resources matching the specified family and gender (how to search by string and how to search by token)