Implementation Guide for ARF/RHD Register - AU
0.2.0 - ci-build
Implementation Guide for ARF/RHD Register - AU - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://fhir-arf-register.nardhc.org/StructureDefinition/ARFPatient | Version: 0.2.0 | |||
Draft as of 2024-10-28 | Computable Name: ARFPatient |
Profile of Patient with ARF.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUCorePatient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
AUCorePatient | |||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
1..1 | AUIHI(4.2.2-ballot) | Individual Healthcare Identifier (IHI) | |
![]() ![]() ![]() |
1..* | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() |
S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The kind of relationship | |
![]() ![]() ![]() ![]() |
1..1 | HumanName | A name associated with the contact person | |
![]() ![]() ![]() |
S | 1..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information 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 | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status ![]()
| ||||||
![]() ![]() ![]() ![]() |
0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status ![]() | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||||
![]() ![]() ![]() ![]() |
0..1 | date | The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival | |||||||
![]() ![]() ![]() ![]() |
SOC | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
| ||||||
![]() ![]() ![]() ![]() |
SOC | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
| ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
SOC | 1..* | Identifier, AUIHI(4.2.2-ballot), AUMedicareCardNumber(4.2.2-ballot), AUDVANumber(4.2.2-ballot), AUHealthCareCardNumber(4.2.2-ballot), AUPensionerConcessionCardNumber(4.2.2-ballot), AUCwlthSeniorsHealthCardNumber(4.2.2-ballot), AUMedicalRecordNumber(4.2.2-ballot), AUInsuranceMemberNumber(4.2.2-ballot) | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
![]() ![]() ![]() ![]() |
SOC | 1..1 | AUIHI(4.2.2-ballot) | 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
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AUMedicareCardNumber(4.2.2-ballot) | Medicare Card Number
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AUDVANumber(4.2.2-ballot) | Department of Veterans' Affairs (DVA) Number
| ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
![]() ![]() ![]() |
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
| ||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
![]() ![]() ![]() |
SOΣ | 1..* | ContactPoint | A contact detail for the individual
| ||||||
![]() ![]() ![]() |
SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
![]() ![]() ![]() |
SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
![]() ![]() ![]() |
?!SΣ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Deceased indicator | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Deceased date time | ||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() |
SOC | 0..* | AustralianAddress(4.2.2-ballot), 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'
| ||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
| ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia ![]()
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | boolean | Language preference indicator
| ||||||
![]() ![]() ![]() |
S | 1..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | ||||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
![]() |
Path | Conformance | ValueSet | URI |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | |
Patient.communication.language | extensible | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-add-0 | error | Patient.address | The address shall at least have text or a line : text.exists() or line.exists() | |
inv-add-1 | error | Patient.address | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' | |
inv-add-2 | error | Patient.address | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') | |
inv-ihi-value-0 | error | Patient.identifier:ihi | IHI shall be an exactly 16 digit number : value.matches('^([0-9]{16})$') | |
inv-ihi-value-1 | error | Patient.identifier:ihi | IHI prefix is 800360 : value.startsWith('800360') | |
inv-ihi-value-2 | error | Patient.identifier:ihi | IHI shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0) | |
inv-pat-0 | error | Patient | If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString() | |
inv-pat-1 | warning | Patient | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-pat-2 | warning | Patient | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) | |
inv-pat-3 | warning | Patient | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) | |
inv-pat-4 | warning | Patient | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) | |
inv-pat-5 | warning | Patient | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information 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 | ||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status ![]()
| ||||||
![]() ![]() ![]() ![]() |
0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status ![]() | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||||
![]() ![]() ![]() ![]() |
0..1 | date | The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival | |||||||
![]() ![]() ![]() ![]() |
SOC | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
| ||||||
![]() ![]() ![]() ![]() |
SOC | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
| ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
SOC | 1..* | Identifier, AUIHI(4.2.2-ballot), AUMedicareCardNumber(4.2.2-ballot), AUDVANumber(4.2.2-ballot), AUHealthCareCardNumber(4.2.2-ballot), AUPensionerConcessionCardNumber(4.2.2-ballot), AUCwlthSeniorsHealthCardNumber(4.2.2-ballot), AUMedicalRecordNumber(4.2.2-ballot), AUInsuranceMemberNumber(4.2.2-ballot) | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
![]() ![]() ![]() ![]() |
SOC | 1..1 | AUIHI(4.2.2-ballot) | 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
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AUMedicareCardNumber(4.2.2-ballot) | Medicare Card Number
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AUDVANumber(4.2.2-ballot) | Department of Veterans' Affairs (DVA) Number
| ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
![]() ![]() ![]() |
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
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | ContactPoint | A contact detail for the individual
| ||||||
![]() ![]() ![]() |
SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
![]() ![]() ![]() |
SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
![]() ![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||||
![]() ![]() ![]() |
?!SΣ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Deceased indicator | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Deceased date time | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Primitive value for dateTime | |||||||
![]() ![]() ![]() |
SOC | 0..* | AustralianAddress(4.2.2-ballot), 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'
| ||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||
![]() ![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() ![]() |
integer | |||||||||
![]() ![]() ![]() |
0..* | Attachment | Image of the patient | |||||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The kind of relationship Binding: Contact Relationship Type ![]() | |||||||
![]() ![]() ![]() ![]() |
1..1 | HumanName | A name associated with the contact person | |||||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||||
![]() ![]() ![]() ![]() |
0..1 | Address, AustralianAddress(4.2.2-ballot) | Address for the contact person | |||||||
![]() ![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||||
![]() ![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia ![]()
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | boolean | Language preference indicator
| ||||||
![]() ![]() ![]() |
S | 1..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
![]() |
Path | Conformance | ValueSet | URI | |||
Patient.language | preferred | 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 |
Id | Grade | Path(s) | Details | Requirements |
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-add-0 | error | Patient.address | The address shall at least have text or a line : text.exists() or line.exists() | |
inv-add-1 | error | Patient.address | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' | |
inv-add-2 | error | Patient.address | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') | |
inv-ihi-value-0 | error | Patient.identifier:ihi | IHI shall be an exactly 16 digit number : value.matches('^([0-9]{16})$') | |
inv-ihi-value-1 | error | Patient.identifier:ihi | IHI prefix is 800360 : value.startsWith('800360') | |
inv-ihi-value-2 | error | Patient.identifier:ihi | IHI shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0) | |
inv-pat-0 | error | Patient | If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString() | |
inv-pat-1 | warning | Patient | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-pat-2 | warning | Patient | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) | |
inv-pat-3 | warning | Patient | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) | |
inv-pat-4 | warning | Patient | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) | |
inv-pat-5 | warning | Patient | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
This structure is derived from AUCorePatient
Differential View
This structure is derived from AUCorePatient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
AUCorePatient | |||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
1..1 | AUIHI(4.2.2-ballot) | Individual Healthcare Identifier (IHI) | |
![]() ![]() ![]() |
1..* | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() |
S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The kind of relationship | |
![]() ![]() ![]() ![]() |
1..1 | HumanName | A name associated with the contact person | |
![]() ![]() ![]() |
S | 1..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information 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 | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status ![]()
| ||||||
![]() ![]() ![]() ![]() |
0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status ![]() | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||||
![]() ![]() ![]() ![]() |
0..1 | date | The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival | |||||||
![]() ![]() ![]() ![]() |
SOC | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
| ||||||
![]() ![]() ![]() ![]() |
SOC | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
| ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
SOC | 1..* | Identifier, AUIHI(4.2.2-ballot), AUMedicareCardNumber(4.2.2-ballot), AUDVANumber(4.2.2-ballot), AUHealthCareCardNumber(4.2.2-ballot), AUPensionerConcessionCardNumber(4.2.2-ballot), AUCwlthSeniorsHealthCardNumber(4.2.2-ballot), AUMedicalRecordNumber(4.2.2-ballot), AUInsuranceMemberNumber(4.2.2-ballot) | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
![]() ![]() ![]() ![]() |
SOC | 1..1 | AUIHI(4.2.2-ballot) | 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
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AUMedicareCardNumber(4.2.2-ballot) | Medicare Card Number
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AUDVANumber(4.2.2-ballot) | Department of Veterans' Affairs (DVA) Number
| ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
![]() ![]() ![]() |
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
| ||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
![]() ![]() ![]() |
SOΣ | 1..* | ContactPoint | A contact detail for the individual
| ||||||
![]() ![]() ![]() |
SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
![]() ![]() ![]() |
SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
![]() ![]() ![]() |
?!SΣ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Deceased indicator | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Deceased date time | ||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() |
SOC | 0..* | AustralianAddress(4.2.2-ballot), 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'
| ||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
| ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia ![]()
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | boolean | Language preference indicator
| ||||||
![]() ![]() ![]() |
S | 1..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | ||||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
![]() |
Path | Conformance | ValueSet | URI |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | |
Patient.communication.language | extensible | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-add-0 | error | Patient.address | The address shall at least have text or a line : text.exists() or line.exists() | |
inv-add-1 | error | Patient.address | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' | |
inv-add-2 | error | Patient.address | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') | |
inv-ihi-value-0 | error | Patient.identifier:ihi | IHI shall be an exactly 16 digit number : value.matches('^([0-9]{16})$') | |
inv-ihi-value-1 | error | Patient.identifier:ihi | IHI prefix is 800360 : value.startsWith('800360') | |
inv-ihi-value-2 | error | Patient.identifier:ihi | IHI shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0) | |
inv-pat-0 | error | Patient | If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString() | |
inv-pat-1 | warning | Patient | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-pat-2 | warning | Patient | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) | |
inv-pat-3 | warning | Patient | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) | |
inv-pat-4 | warning | Patient | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) | |
inv-pat-5 | warning | Patient | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information 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 | ||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status ![]()
| ||||||
![]() ![]() ![]() ![]() |
0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status ![]() | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||||
![]() ![]() ![]() ![]() |
0..1 | date | The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival | |||||||
![]() ![]() ![]() ![]() |
SOC | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
| ||||||
![]() ![]() ![]() ![]() |
SOC | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
| ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
SOC | 1..* | Identifier, AUIHI(4.2.2-ballot), AUMedicareCardNumber(4.2.2-ballot), AUDVANumber(4.2.2-ballot), AUHealthCareCardNumber(4.2.2-ballot), AUPensionerConcessionCardNumber(4.2.2-ballot), AUCwlthSeniorsHealthCardNumber(4.2.2-ballot), AUMedicalRecordNumber(4.2.2-ballot), AUInsuranceMemberNumber(4.2.2-ballot) | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
![]() ![]() ![]() ![]() |
SOC | 1..1 | AUIHI(4.2.2-ballot) | 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
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AUMedicareCardNumber(4.2.2-ballot) | Medicare Card Number
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | AUDVANumber(4.2.2-ballot) | Department of Veterans' Affairs (DVA) Number
| ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
![]() ![]() ![]() |
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
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | ContactPoint | A contact detail for the individual
| ||||||
![]() ![]() ![]() |
SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
![]() ![]() ![]() |
SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
![]() ![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||||
![]() ![]() ![]() |
?!SΣ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Deceased indicator | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Deceased date time | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator ![]() | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Primitive value for dateTime | |||||||
![]() ![]() ![]() |
SOC | 0..* | AustralianAddress(4.2.2-ballot), 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'
| ||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||
![]() ![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() ![]() |
integer | |||||||||
![]() ![]() ![]() |
0..* | Attachment | Image of the patient | |||||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The kind of relationship Binding: Contact Relationship Type ![]() | |||||||
![]() ![]() ![]() ![]() |
1..1 | HumanName | A name associated with the contact person | |||||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||||
![]() ![]() ![]() ![]() |
0..1 | Address, AustralianAddress(4.2.2-ballot) | Address for the contact person | |||||||
![]() ![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||||
![]() ![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia ![]()
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | boolean | Language preference indicator
| ||||||
![]() ![]() ![]() |
S | 1..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
![]() |
Path | Conformance | ValueSet | URI | |||
Patient.language | preferred | 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 |
Id | Grade | Path(s) | Details | Requirements |
au-core-pat-01 | error | Patient | At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present : (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-02 | error | Patient | At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present : name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present : (text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-add-0 | error | Patient.address | The address shall at least have text or a line : text.exists() or line.exists() | |
inv-add-1 | error | Patient.address | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' | |
inv-add-2 | error | Patient.address | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') | |
inv-ihi-value-0 | error | Patient.identifier:ihi | IHI shall be an exactly 16 digit number : value.matches('^([0-9]{16})$') | |
inv-ihi-value-1 | error | Patient.identifier:ihi | IHI prefix is 800360 : value.startsWith('800360') | |
inv-ihi-value-2 | error | Patient.identifier:ihi | IHI shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0) | |
inv-pat-0 | error | Patient | If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString() | |
inv-pat-1 | warning | Patient | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-pat-2 | warning | Patient | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) | |
inv-pat-3 | warning | Patient | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) | |
inv-pat-4 | warning | Patient | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) | |
inv-pat-5 | warning | Patient | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
This structure is derived from AUCorePatient
Other representations of profile: CSV, Excel, Schematron