AU Core Implementation Guide
0.2.0-preview - QA Preview
AU Core Implementation Guide
0.2.0-preview - QA Preview
This page is part of the Australian Core IG (v0.2.0-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient | Version: 0.2.0-preview | |||
| Standards status: Draft | Maturity Level: 0 | 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.
The following are supported usage scenarios for this profile:
A resource conforming to this profile is conformant to:
Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.
Patient.identifier if available, in preference to Medicare or DVA numbersSpecific feedback is sought on preferred identifiers to support where an individual is not eligible for an IHI e.g. tourist or other temporary stay in Australia. Passport is proposed for use (see example Patient/italia-sofia).
Specific feedback is sought on whether MRN is to be a supported identifier for patients.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBasePatient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | C | 0..* | AUBasePatient | A patient in the context of electronic exchange of health information au-core-pat-01: At least one patient identifier shall be valid au-core-pat-02: At least one patient name shall have a family name |
  extension:birthPlace | S | 0..1 | birthPlace | Place of Birth for patient |
| extension:indigenousStatus | S | 0..1 | AustralianIndigenousStatus | Indigenous status |
| extension:interpreterRequired | S | 0..1 | interpreterRequired | Whether the patient needs an interpreter |
| extension:dateOfArrival | S | 0..1 | DateOfArrivalAustralia | Year of Arrival |
  Slices for identifier | SC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type |
  identifier:ihi | S | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) |
| identifier:medicare | S | 0..1 | AUMedicareCardNumber | Medicare Card Number |
 identifier:dva | S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number |
 active | 0..1 | boolean | Whether this patient's record is in active use Fixed Value: true | |
| name | SC | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present |
| telecom | S | 0..* | ContactPoint | A contact detail for the individual |
| gender | S | 1..1 | code | male | female | other | unknown |
| birthDate | S | 1..1 | date | Date of birth extended for time and accuracy indicator |
| extension:accuracyIndicator | S | 0..1 | DateAccuracyIndicator | Date accuracy indicator |
 extension:birthTime | S | 0..1 | birthTime | Time of day of birth |
| address | S | 0..* | AustralianAddress, Address | An address for the individual |
 communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
 language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health |
| preferred | S | 0..1 | boolean | Language preference indicator |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| au-core-pat-01 | error | Patient | At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists() | |
| au-core-pat-02 | error | Patient | At least one patient name shall have a family name : name.family.exists() | |
| au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present : text.exists() or family.exists() or given.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | C | 0..* | AUBasePatient | A patient in the context of electronic exchange of health information au-core-pat-01: At least one patient identifier shall be valid au-core-pat-02: At least one patient name shall have a family name |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
| indigenousStatus | S | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required) |
| closingTheGapRegistration | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |
| mothersMaidenName | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |
| interpreterRequired | S | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired |
| dateOfArrival | S | 0..1 | date | Year of Arrival URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival |
| genderIdentity | 0..1 | CodeableConcept | The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | |
  extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" | |
 Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example) | |
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible) | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type |
| identifier:ihi | SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) |
| identifier:medicare | S | 0..1 | AUMedicareCardNumber | Medicare Card Number |
| identifier:dva | S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use Fixed Value: true |
 name | SΣC | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present |
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the individual |
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | SΣ | 1..1 | date | Date of birth extended for time and accuracy indicator |
| accuracyIndicator | S | 0..1 | Coding | Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding |
| birthTime | S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator |
 deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time |
 accuracyIndicator | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding | |
| address | SC | 0..* | AustralianAddress, Address | An address for the individual |
| communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) |
| preferred | S | 0..1 | boolean | Language preference indicator |
| link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.extension:genderIdentity.value[x] | example | GenderIdentity |
| Patient.extension:genderIdentity.value[x]:valueCodeableConcept | extensible | https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 |
| Patient.gender | required | AdministrativeGender |
| Patient.communication.language | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-pat-01 | error | Patient | At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists() | |
| au-core-pat-02 | error | Patient | At least one patient name shall have a family name : name.family.exists() | |
| au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present : text.exists() or family.exists() or given.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | C | 0..* | AUBasePatient | A patient in the context of electronic exchange of health information au-core-pat-01: At least one patient identifier shall be valid au-core-pat-02: At least one patient name shall have a family name | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
| indigenousStatus | S | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required) | ||||
| closingTheGapRegistration | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||
| mothersMaidenName | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||
| interpreterRequired | S | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | ||||
| dateOfArrival | S | 0..1 | date | Year of Arrival URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival | ||||
| genderIdentity | 0..1 | CodeableConcept | The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" | |||||
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example) | |||||
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible) | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type | ||||
| identifier:ihi | SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) | ||||
| identifier:medicare | S | 0..1 | AUMedicareCardNumber | Medicare Card Number | ||||
| identifier:dva | S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number | ||||
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use Fixed Value: true | ||||
| name | SΣC | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present | ||||
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the individual | ||||
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | SΣ | 1..1 | date | Date of birth extended for time and accuracy indicator | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| accuracyIndicator | S | 0..1 | Coding | Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding | ||||
| birthTime | S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||
| value | 0..1 | date | Primitive value for date | |||||
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator | ||||
| deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| accuracyIndicator | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding | |||||
| value | 0..1 | dateTime | Primitive value for dateTime | |||||
| address | SC | 0..* | AustralianAddress, Address | An address for the individual | ||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
 multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | 0..* | Attachment | Image of the patient | |||||
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible) | |||||
| name | 0..1 | HumanName | A name associated with the contact person | |||||
| telecom | 0..* | ContactPoint | A contact detail for the person | |||||
| address | 0..1 | Address, AustralianAddress | Address for the contact person | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | ||||
| preferred | S | 0..1 | boolean | Language preference indicator | ||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.extension:genderIdentity.value[x] | example | GenderIdentity | ||||
| Patient.extension:genderIdentity.value[x]:valueCodeableConcept | extensible | https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.maritalStatus | extensible | Marital Status Codes | ||||
| Patient.contact.relationship | extensible | https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present : text.exists() or family.exists() or given.exists() |
This structure is derived from AUBasePatient
Summary
Mandatory: 4 elements
Must-Support: 18 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from AUBasePatient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | C | 0..* | AUBasePatient | A patient in the context of electronic exchange of health information au-core-pat-01: At least one patient identifier shall be valid au-core-pat-02: At least one patient name shall have a family name |
| extension:birthPlace | S | 0..1 | birthPlace | Place of Birth for patient |
| extension:indigenousStatus | S | 0..1 | AustralianIndigenousStatus | Indigenous status |
| extension:interpreterRequired | S | 0..1 | interpreterRequired | Whether the patient needs an interpreter |
| extension:dateOfArrival | S | 0..1 | DateOfArrivalAustralia | Year of Arrival |
| Slices for identifier | SC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type |
| identifier:ihi | S | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) |
| identifier:medicare | S | 0..1 | AUMedicareCardNumber | Medicare Card Number |
| identifier:dva | S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number |
| active | 0..1 | boolean | Whether this patient's record is in active use Fixed Value: true | |
| name | SC | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present |
| telecom | S | 0..* | ContactPoint | A contact detail for the individual |
| gender | S | 1..1 | code | male | female | other | unknown |
| birthDate | S | 1..1 | date | Date of birth extended for time and accuracy indicator |
| extension:accuracyIndicator | S | 0..1 | DateAccuracyIndicator | Date accuracy indicator |
| extension:birthTime | S | 0..1 | birthTime | Time of day of birth |
| address | S | 0..* | AustralianAddress, Address | An address for the individual |
| communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
| language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health |
| preferred | S | 0..1 | boolean | Language preference indicator |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| au-core-pat-01 | error | Patient | At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists() | |
| au-core-pat-02 | error | Patient | At least one patient name shall have a family name : name.family.exists() | |
| au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present : text.exists() or family.exists() or given.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | C | 0..* | AUBasePatient | A patient in the context of electronic exchange of health information au-core-pat-01: At least one patient identifier shall be valid au-core-pat-02: At least one patient name shall have a family name |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
| indigenousStatus | S | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required) |
| closingTheGapRegistration | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |
| mothersMaidenName | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |
| interpreterRequired | S | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired |
| dateOfArrival | S | 0..1 | date | Year of Arrival URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival |
| genderIdentity | 0..1 | CodeableConcept | The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" | |
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example) | |
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible) | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type |
| identifier:ihi | SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) |
| identifier:medicare | S | 0..1 | AUMedicareCardNumber | Medicare Card Number |
| identifier:dva | S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use Fixed Value: true |
| name | SΣC | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present |
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the individual |
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | SΣ | 1..1 | date | Date of birth extended for time and accuracy indicator |
| accuracyIndicator | S | 0..1 | Coding | Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding |
| birthTime | S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator |
| deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time |
| accuracyIndicator | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding | |
| address | SC | 0..* | AustralianAddress, Address | An address for the individual |
| communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) |
| preferred | S | 0..1 | boolean | Language preference indicator |
| link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.extension:genderIdentity.value[x] | example | GenderIdentity |
| Patient.extension:genderIdentity.value[x]:valueCodeableConcept | extensible | https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 |
| Patient.gender | required | AdministrativeGender |
| Patient.communication.language | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-pat-01 | error | Patient | At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists() | |
| au-core-pat-02 | error | Patient | At least one patient name shall have a family name : name.family.exists() | |
| au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present : text.exists() or family.exists() or given.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | C | 0..* | AUBasePatient | A patient in the context of electronic exchange of health information au-core-pat-01: At least one patient identifier shall be valid au-core-pat-02: At least one patient name shall have a family name | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
| indigenousStatus | S | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required) | ||||
| closingTheGapRegistration | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||
| mothersMaidenName | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||
| interpreterRequired | S | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | ||||
| dateOfArrival | S | 0..1 | date | Year of Arrival URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival | ||||
| genderIdentity | 0..1 | CodeableConcept | The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" | |||||
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example) | |||||
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible) | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type | ||||
| identifier:ihi | SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) | ||||
| identifier:medicare | S | 0..1 | AUMedicareCardNumber | Medicare Card Number | ||||
| identifier:dva | S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number | ||||
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use Fixed Value: true | ||||
| name | SΣC | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present | ||||
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the individual | ||||
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | SΣ | 1..1 | date | Date of birth extended for time and accuracy indicator | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| accuracyIndicator | S | 0..1 | Coding | Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding | ||||
| birthTime | S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||
| value | 0..1 | date | Primitive value for date | |||||
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator | ||||
| deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| accuracyIndicator | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding | |||||
| value | 0..1 | dateTime | Primitive value for dateTime | |||||
| address | SC | 0..* | AustralianAddress, Address | An address for the individual | ||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | 0..* | Attachment | Image of the patient | |||||
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible) | |||||
| name | 0..1 | HumanName | A name associated with the contact person | |||||
| telecom | 0..* | ContactPoint | A contact detail for the person | |||||
| address | 0..1 | Address, AustralianAddress | Address for the contact person | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | ||||
| preferred | S | 0..1 | boolean | Language preference indicator | ||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.extension:genderIdentity.value[x] | example | GenderIdentity | ||||
| Patient.extension:genderIdentity.value[x]:valueCodeableConcept | extensible | https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.maritalStatus | extensible | Marital Status Codes | ||||
| Patient.contact.relationship | extensible | https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present : text.exists() or family.exists() or given.exists() |
This structure is derived from AUBasePatient
Summary
Mandatory: 4 elements
Must-Support: 18 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described 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.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| _id | SHALL | token |
|
| identifier | SHALL | token |
The client SHALL provide both the system and code values. The server SHALL support both. The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the profile. The server 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 client SHALL provide a value precise to the day. A server SHALL support a value precise to the day offset. |
| gender | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| indigenous-status | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| patient-gender-identity | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
_id search parameter:
_revinclude parameters: Provenance:targetGET [base]/Patient/[id] or GET [base]/Patient?_id=[id]
Example:
Implementation Notes: Returns a single Patient resource. (how to search by the logical id of the resource)
identifier search parameter:
_revinclude parameters: Provenance:targetGET [base]/Patient?identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle containing any Patient resources matching the identifier (how to search by token)
Implementation Notes: Fetches a bundle of all Patient resources matching the name (how to search by string)
The following search parameters and search parameter combinations SHOULD be supported:
name search parameter:
_revinclude parameters: Provenance:targetGET [base]/Patient?name=[string]
Example:
gender and name search parameters:
_revinclude parameters: Provenance:targetGET [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:
_revinclude parameters: Provenance:targetGET [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:
_revinclude parameters: Provenance:targetGET [base]/Patient?birthdate=[date]&name=[string]
Example:
Implementation Notes: Fetches a bundle of all Patient resources matching the specified birthdate and name (how to search by date and how to search by string)
family and gender search parameters:
_revinclude parameters: Provenance:targetGET [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)
gender and name search parameters:
_revinclude parameters: Provenance:targetGET [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 token and how to search by string)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.2.0-preview based on FHIR 4.0.1. Generated 2023-08-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change