Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-mhr-1 | Version: 0.0.2 | |||
Draft as of 2024-09-12 | Computable Name: ADHAPatientMHR | |||
Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
The purpose of this profile is to define a representation of a patient for exchange usage scenarios with the My Health Record system infrastructure in Australia.
This profile supports Cultural and Linguistic Diversity (CALD) data set [1] [2], including country of birth, year of arrival and preferred language.
This profile identifies the additional constraints, extensions, and value sets that build on and extend Patient that are supported.
This profile is designed to set a Patient standard:
This profile may be referred to by APIs, which will be listed here when available.
Patient.extension
birthPlace extension.
address.text
if they birth place address is not stored in discrete elements.Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ADHAPatientCore
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | ADHAPatientCore | A patient in the context of electronic exchange of health information with the MHR system | |
Slices for extension | Content/Rules for all slices | |||
extension:indigenousStatus | 1..1 | AustralianIndigenousStatus | Indigenous status | |
Slices for identifier | Content/Rules for all slices | |||
identifier:ihi | 1..1 | AUIHI | Individual Healthcare Identifier (IHI) | |
deceased[x] | S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
Slices for deceased[x] | Content/Rules for all slices | |||
deceased[x]:deceasedBoolean | S | 0..1 | boolean | Deceased indicator |
deceased[x]:deceasedDateTime | S | 0..1 | dateTime | Deceased date time |
Slices for extension | Content/Rules for all slices | |||
extension:accuracyIndicator | S | 0..1 | DateAccuracyIndicator | Date accuracy indicator |
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient |
multipleBirth[x] | S | 0..1 | boolean, integer | Whether patient is part of a multiple birth |
photo | 0..0 | |||
generalPractitioner | 0..1 | Reference(AU Core Organization | AU Core PractitionerRole) | Patient's nominated primary care provider | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | ADHAPatientCore | A patient in the context of electronic exchange of health information with the MHR system inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply au-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present au-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present inv-dh-pat-01: If present, a general practitioner shall at least have a reference, an identifier or a display | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
birthPlace | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
indigenousStatus | SO | 1..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
| ||||||
veteranStatus | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (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 | 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 | 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
| ||||||
individualPronouns | 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
| ||||||
recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
Slices for identifier | SOC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
identifier:ihi | SOC | 1..1 | AUIHI | Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
| ||||||
identifier:medicare | SO | 0..1 | AUMedicareCardNumber | Medicare Card Number
| ||||||
identifier:dva | SO | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
| ||||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
name | SOΣC | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
| ||||||
use | ?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
text | SOΣ | 0..1 | string | Text representation of the full name
| ||||||
family | SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
given | 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
| ||||||
telecom | SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||
gender | SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
birthDate | SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
Slices for extension | Content/Rules for all slices | |||||||||
accuracyIndicator | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |||||||
birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
Slices for deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
deceasedBoolean | boolean | |||||||||
deceasedDateTime | dateTime | |||||||||
deceased[x]:deceasedBoolean | ?!SΣ | 0..1 | boolean | Deceased indicator | ||||||
deceased[x]:deceasedDateTime | ?!SΣ | 0..1 | dateTime | Deceased date time | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
accuracyIndicator | S | 0..1 | Coding | Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | ||||||
address | SOC | 0..* | AustralianAddress, Address | An address for the individual inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
| ||||||
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||||
multipleBirth[x] | S | 0..1 | Whether patient is part of a multiple birth | |||||||
multipleBirthBoolean | boolean | |||||||||
multipleBirthInteger | integer | |||||||||
communication | SO | 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 | 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 (extensible)
| ||||||
preferred | SO | 0..1 | boolean | Language preference indicator
| ||||||
generalPractitioner | SC | 0..1 | Reference(AU Core Organization | AU Core PractitionerRole) | Patient's nominated primary care provider | ||||||
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 | URI |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-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.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 |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | ADHAPatientCore | A patient in the context of electronic exchange of health information with the MHR system inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply au-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present au-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present inv-dh-pat-01: If present, a general practitioner shall at least have a reference, an identifier or a display | ||||||
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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
birthPlace | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
indigenousStatus | SO | 1..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
| ||||||
veteranStatus | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (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 | 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 | 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
| ||||||
individualPronouns | 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
| ||||||
recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
Slices for identifier | SOC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
identifier:ihi | SOC | 1..1 | AUIHI | Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
| ||||||
identifier:medicare | SO | 0..1 | AUMedicareCardNumber | Medicare Card Number
| ||||||
identifier:dva | SO | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
| ||||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
name | SOΣC | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
use | ?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
text | SOΣ | 0..1 | string | Text representation of the full name
| ||||||
family | SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
given | 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
| ||||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||||
telecom | SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||
gender | SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
birthDate | SOΣC | 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 | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |||||||
birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
value | 0..1 | date | Primitive value for date | |||||||
Slices for deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
deceasedBoolean | boolean | |||||||||
deceasedDateTime | dateTime | |||||||||
deceased[x]:deceasedBoolean | ?!SΣ | 0..1 | boolean | Deceased indicator | ||||||
deceased[x]:deceasedDateTime | ?!SΣ | 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 | S | 0..1 | Coding | Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | ||||||
value | 0..1 | dateTime | Primitive value for dateTime | |||||||
address | SOC | 0..* | AustralianAddress, Address | An address for the individual inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
| ||||||
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||||
multipleBirth[x] | S | 0..1 | Whether patient is part of a multiple birth | |||||||
multipleBirthBoolean | boolean | |||||||||
multipleBirthInteger | integer | |||||||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||||
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: Contact Relationship Type (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 | SO | 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 | 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 (extensible)
| ||||||
preferred | SO | 0..1 | boolean | Language preference indicator
| ||||||
generalPractitioner | SC | 0..1 | Reference(AU Core Organization | AU Core 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 | URI | |||
Patient.language | preferred | CommonLanguages
http://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.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 |
This structure is derived from ADHAPatientCore
Differential View
This structure is derived from ADHAPatientCore
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | ADHAPatientCore | A patient in the context of electronic exchange of health information with the MHR system | |
Slices for extension | Content/Rules for all slices | |||
extension:indigenousStatus | 1..1 | AustralianIndigenousStatus | Indigenous status | |
Slices for identifier | Content/Rules for all slices | |||
identifier:ihi | 1..1 | AUIHI | Individual Healthcare Identifier (IHI) | |
deceased[x] | S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
Slices for deceased[x] | Content/Rules for all slices | |||
deceased[x]:deceasedBoolean | S | 0..1 | boolean | Deceased indicator |
deceased[x]:deceasedDateTime | S | 0..1 | dateTime | Deceased date time |
Slices for extension | Content/Rules for all slices | |||
extension:accuracyIndicator | S | 0..1 | DateAccuracyIndicator | Date accuracy indicator |
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient |
multipleBirth[x] | S | 0..1 | boolean, integer | Whether patient is part of a multiple birth |
photo | 0..0 | |||
generalPractitioner | 0..1 | Reference(AU Core Organization | AU Core PractitionerRole) | Patient's nominated primary care provider | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | ADHAPatientCore | A patient in the context of electronic exchange of health information with the MHR system inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply au-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present au-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present inv-dh-pat-01: If present, a general practitioner shall at least have a reference, an identifier or a display | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
birthPlace | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
indigenousStatus | SO | 1..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
| ||||||
veteranStatus | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (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 | 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 | 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
| ||||||
individualPronouns | 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
| ||||||
recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
Slices for identifier | SOC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
identifier:ihi | SOC | 1..1 | AUIHI | Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
| ||||||
identifier:medicare | SO | 0..1 | AUMedicareCardNumber | Medicare Card Number
| ||||||
identifier:dva | SO | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
| ||||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
name | SOΣC | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
| ||||||
use | ?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
text | SOΣ | 0..1 | string | Text representation of the full name
| ||||||
family | SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
given | 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
| ||||||
telecom | SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||
gender | SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
birthDate | SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
Slices for extension | Content/Rules for all slices | |||||||||
accuracyIndicator | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |||||||
birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
Slices for deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
deceasedBoolean | boolean | |||||||||
deceasedDateTime | dateTime | |||||||||
deceased[x]:deceasedBoolean | ?!SΣ | 0..1 | boolean | Deceased indicator | ||||||
deceased[x]:deceasedDateTime | ?!SΣ | 0..1 | dateTime | Deceased date time | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
accuracyIndicator | S | 0..1 | Coding | Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | ||||||
address | SOC | 0..* | AustralianAddress, Address | An address for the individual inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
| ||||||
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||||
multipleBirth[x] | S | 0..1 | Whether patient is part of a multiple birth | |||||||
multipleBirthBoolean | boolean | |||||||||
multipleBirthInteger | integer | |||||||||
communication | SO | 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 | 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 (extensible)
| ||||||
preferred | SO | 0..1 | boolean | Language preference indicator
| ||||||
generalPractitioner | SC | 0..1 | Reference(AU Core Organization | AU Core PractitionerRole) | Patient's nominated primary care provider | ||||||
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 | URI |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-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.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 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | ADHAPatientCore | A patient in the context of electronic exchange of health information with the MHR system inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply au-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present au-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present inv-dh-pat-01: If present, a general practitioner shall at least have a reference, an identifier or a display | ||||||
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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
birthPlace | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
indigenousStatus | SO | 1..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
| ||||||
veteranStatus | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (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 | 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 | 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
| ||||||
individualPronouns | 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
| ||||||
recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
Slices for identifier | SOC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
identifier:ihi | SOC | 1..1 | AUIHI | Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
| ||||||
identifier:medicare | SO | 0..1 | AUMedicareCardNumber | Medicare Card Number
| ||||||
identifier:dva | SO | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
| ||||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
name | SOΣC | 1..* | HumanName | A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
use | ?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
text | SOΣ | 0..1 | string | Text representation of the full name
| ||||||
family | SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
given | 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
| ||||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||||
telecom | SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||
gender | SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
birthDate | SOΣC | 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 | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |||||||
birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
value | 0..1 | date | Primitive value for date | |||||||
Slices for deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
deceasedBoolean | boolean | |||||||||
deceasedDateTime | dateTime | |||||||||
deceased[x]:deceasedBoolean | ?!SΣ | 0..1 | boolean | Deceased indicator | ||||||
deceased[x]:deceasedDateTime | ?!SΣ | 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 | S | 0..1 | Coding | Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | ||||||
value | 0..1 | dateTime | Primitive value for dateTime | |||||||
address | SOC | 0..* | AustralianAddress, Address | An address for the individual inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
| ||||||
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||||
multipleBirth[x] | S | 0..1 | Whether patient is part of a multiple birth | |||||||
multipleBirthBoolean | boolean | |||||||||
multipleBirthInteger | integer | |||||||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||||
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: Contact Relationship Type (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 | SO | 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 | 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 (extensible)
| ||||||
preferred | SO | 0..1 | boolean | Language preference indicator
| ||||||
generalPractitioner | SC | 0..1 | Reference(AU Core Organization | AU Core 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 | URI | |||
Patient.language | preferred | CommonLanguages
http://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.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 |
This structure is derived from ADHAPatientCore
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.