Helix AU Core
0.1.0 - ci-build
Helix AU Core - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://medicaldirector.com/fhir/helix-au-core/StructureDefinition/HelixAUCorePatient | Version: 0.1.0 | |||
| Draft as of 2025-08-12 | Computable Name: HelixAUCorePatient | |||
A patient in the context of MedicalDirector Helix.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information Constraints: inv-pat-0, au-core-pat-01, au-core-pat-02 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
![]() ![]() ![]() |
S | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
S | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired |
![]() ![]() ![]() |
S | 0..1 | date | Year of Arrival URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival |
![]() ![]() ![]() |
0..1 | (Complex) | The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity | |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Gender Identity Response (extensible) | |
![]() ![]() ![]() |
0..1 | Coding | Helix Patient Status URL: http://medicaldirector.com/fhir/helix-base/StructureDefinition/helix-patient-status Binding: Helix Patient Status (required) | |
![]() ![]() ![]() |
0..1 | boolean | Helix AU Core Patient SMS Opt-in URL: http://medicaldirector.com/fhir/helix-base/StructureDefinition/sms-opt-in | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) Constraints: inv-ihi-value-0, inv-ihi-value-1, inv-ihi-value-2 |
![]() ![]() ![]() |
S | 0..1 | AUMedicareCardNumber | Medicare Card Number |
![]() ![]() ![]() |
S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number |
![]() ![]() ![]() |
SC | 1..1 | HelixBaseAuthoringKey | Identifies this patient across multiple systems |
![]() ![]() ![]() |
SC | 0..1 | HelixAUCoreMedicalRecordNumber | Identifies this patient across multiple systems |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use Fixed Value: true |
![]() ![]() |
SΣC | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-04 |
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() |
SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() |
SΣ | 1..1 | date | Date of birth extended for time and accuracy indicator |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Deceased indicator |
![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Deceased date time |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
![]() ![]() |
SC | 0..* | AustralianAddress, Address | An address for the individual Constraints: inv-add-0, inv-add-1, inv-add-2 |
![]() ![]() |
S | 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 |
![]() ![]() ![]() |
S | 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) |
![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator |
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Patient.extension:genderIdentity.value[x] | example | GenderIdentityhttp://hl7.org/fhir/ValueSet/gender-identityFrom the FHIR Standard | |
| Patient.extension:genderIdentity.value[x]:valueCodeableConcept | extensible | GenderIdentityResponse ![]() https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 | |
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From 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.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-pat-01 | error | Patient | At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists() | |
| au-core-pat-02 | error | Patient | At least one patient name shall have a family name : name.family.exists() | |
| au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present : text.exists() or family.exists() or given.exists() | |
| 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() |
This structure is derived from AUCorePatient
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUCorePatient | A patient in the context of electronic exchange of health information | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | Coding | Helix Patient Status URL: http://medicaldirector.com/fhir/helix-base/StructureDefinition/helix-patient-status Binding: Helix Patient Status (required) | |
![]() ![]() ![]() |
0..1 | boolean | Helix AU Core Patient SMS Opt-in URL: http://medicaldirector.com/fhir/helix-base/StructureDefinition/sms-opt-in | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 1..1 | HelixBaseAuthoringKey | Identifies this patient across multiple systems |
![]() ![]() ![]() |
0..1 | HelixAUCoreMedicalRecordNumber | Identifies this patient across multiple systems | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information Constraints: inv-pat-0, au-core-pat-01, au-core-pat-02 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
![]() ![]() ![]() |
S | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) | ||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
S | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | ||||
![]() ![]() ![]() |
S | 0..1 | date | Year of Arrival URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival | ||||
![]() ![]() ![]() |
0..1 | (Complex) | The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example) | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Gender Identity Response (extensible) | |||||
![]() ![]() ![]() |
0..1 | Coding | Helix Patient Status URL: http://medicaldirector.com/fhir/helix-base/StructureDefinition/helix-patient-status Binding: Helix Patient Status (required) | |||||
![]() ![]() ![]() |
0..1 | boolean | Helix AU Core Patient SMS Opt-in URL: http://medicaldirector.com/fhir/helix-base/StructureDefinition/sms-opt-in | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() |
SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) Constraints: inv-ihi-value-0, inv-ihi-value-1, inv-ihi-value-2 | ||||
![]() ![]() ![]() |
S | 0..1 | AUMedicareCardNumber | Medicare Card Number | ||||
![]() ![]() ![]() |
S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number | ||||
![]() ![]() ![]() |
SC | 1..1 | HelixBaseAuthoringKey | Identifies this patient across multiple systems | ||||
![]() ![]() ![]() |
SC | 0..1 | HelixAUCoreMedicalRecordNumber | Identifies this patient across multiple systems | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use Fixed Value: true | ||||
![]() ![]() |
SΣC | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-04 | ||||
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() |
SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
SΣ | 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 | |||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||
![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||
![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Deceased indicator | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Deceased date time | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Primitive value for dateTime | |||||
![]() ![]() |
SC | 0..* | AustralianAddress, Address | An address for the individual Constraints: inv-add-0, inv-add-1, inv-add-2 | ||||
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
integer | |||||||
![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type (extensible) | |||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() |
0..1 | Address, AustralianAddress | Address for the contact person | |||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() |
S | 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 | ||||
![]() ![]() ![]() |
S | 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) | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator | ||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Patient.extension:genderIdentity.value[x] | example | GenderIdentityhttp://hl7.org/fhir/ValueSet/gender-identityFrom the FHIR Standard | ||||
| Patient.extension:genderIdentity.value[x]:valueCodeableConcept | extensible | GenderIdentityResponse ![]() https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | ||||
| Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusFrom 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.1From 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.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-pat-01 | error | Patient | At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists() | |
| au-core-pat-02 | error | Patient | At least one patient name shall have a family name : name.family.exists() | |
| au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present : text.exists() or family.exists() or given.exists() | |
| 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() | |
| 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
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information Constraints: inv-pat-0, au-core-pat-01, au-core-pat-02 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
![]() ![]() ![]() |
S | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
S | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired |
![]() ![]() ![]() |
S | 0..1 | date | Year of Arrival URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival |
![]() ![]() ![]() |
0..1 | (Complex) | The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity | |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Gender Identity Response (extensible) | |
![]() ![]() ![]() |
0..1 | Coding | Helix Patient Status URL: http://medicaldirector.com/fhir/helix-base/StructureDefinition/helix-patient-status Binding: Helix Patient Status (required) | |
![]() ![]() ![]() |
0..1 | boolean | Helix AU Core Patient SMS Opt-in URL: http://medicaldirector.com/fhir/helix-base/StructureDefinition/sms-opt-in | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) Constraints: inv-ihi-value-0, inv-ihi-value-1, inv-ihi-value-2 |
![]() ![]() ![]() |
S | 0..1 | AUMedicareCardNumber | Medicare Card Number |
![]() ![]() ![]() |
S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number |
![]() ![]() ![]() |
SC | 1..1 | HelixBaseAuthoringKey | Identifies this patient across multiple systems |
![]() ![]() ![]() |
SC | 0..1 | HelixAUCoreMedicalRecordNumber | Identifies this patient across multiple systems |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use Fixed Value: true |
![]() ![]() |
SΣC | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-04 |
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() |
SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() |
SΣ | 1..1 | date | Date of birth extended for time and accuracy indicator |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Deceased indicator |
![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Deceased date time |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
![]() ![]() |
SC | 0..* | AustralianAddress, Address | An address for the individual Constraints: inv-add-0, inv-add-1, inv-add-2 |
![]() ![]() |
S | 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 |
![]() ![]() ![]() |
S | 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) |
![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator |
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Patient.extension:genderIdentity.value[x] | example | GenderIdentityhttp://hl7.org/fhir/ValueSet/gender-identityFrom the FHIR Standard | |
| Patient.extension:genderIdentity.value[x]:valueCodeableConcept | extensible | GenderIdentityResponse ![]() https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 | |
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From 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.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-pat-01 | error | Patient | At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists() | |
| au-core-pat-02 | error | Patient | At least one patient name shall have a family name : name.family.exists() | |
| au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present : text.exists() or family.exists() or given.exists() | |
| 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() |
Differential View
This structure is derived from AUCorePatient
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUCorePatient | A patient in the context of electronic exchange of health information | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | Coding | Helix Patient Status URL: http://medicaldirector.com/fhir/helix-base/StructureDefinition/helix-patient-status Binding: Helix Patient Status (required) | |
![]() ![]() ![]() |
0..1 | boolean | Helix AU Core Patient SMS Opt-in URL: http://medicaldirector.com/fhir/helix-base/StructureDefinition/sms-opt-in | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 1..1 | HelixBaseAuthoringKey | Identifies this patient across multiple systems |
![]() ![]() ![]() |
0..1 | HelixAUCoreMedicalRecordNumber | Identifies this patient across multiple systems | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information Constraints: inv-pat-0, au-core-pat-01, au-core-pat-02 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
![]() ![]() ![]() |
S | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) | ||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
S | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | ||||
![]() ![]() ![]() |
S | 0..1 | date | Year of Arrival URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival | ||||
![]() ![]() ![]() |
0..1 | (Complex) | The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example) | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Gender Identity Response (extensible) | |||||
![]() ![]() ![]() |
0..1 | Coding | Helix Patient Status URL: http://medicaldirector.com/fhir/helix-base/StructureDefinition/helix-patient-status Binding: Helix Patient Status (required) | |||||
![]() ![]() ![]() |
0..1 | boolean | Helix AU Core Patient SMS Opt-in URL: http://medicaldirector.com/fhir/helix-base/StructureDefinition/sms-opt-in | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() |
SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) Constraints: inv-ihi-value-0, inv-ihi-value-1, inv-ihi-value-2 | ||||
![]() ![]() ![]() |
S | 0..1 | AUMedicareCardNumber | Medicare Card Number | ||||
![]() ![]() ![]() |
S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number | ||||
![]() ![]() ![]() |
SC | 1..1 | HelixBaseAuthoringKey | Identifies this patient across multiple systems | ||||
![]() ![]() ![]() |
SC | 0..1 | HelixAUCoreMedicalRecordNumber | Identifies this patient across multiple systems | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use Fixed Value: true | ||||
![]() ![]() |
SΣC | 1..* | HumanName | A name associated with the patient Constraints: au-core-pat-04 | ||||
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() |
SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
SΣ | 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 | |||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||
![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||
![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Deceased indicator | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Deceased date time | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Primitive value for dateTime | |||||
![]() ![]() |
SC | 0..* | AustralianAddress, Address | An address for the individual Constraints: inv-add-0, inv-add-1, inv-add-2 | ||||
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
integer | |||||||
![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type (extensible) | |||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() |
0..1 | Address, AustralianAddress | Address for the contact person | |||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() |
S | 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 | ||||
![]() ![]() ![]() |
S | 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) | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator | ||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Patient.extension:genderIdentity.value[x] | example | GenderIdentityhttp://hl7.org/fhir/ValueSet/gender-identityFrom the FHIR Standard | ||||
| Patient.extension:genderIdentity.value[x]:valueCodeableConcept | extensible | GenderIdentityResponse ![]() https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | ||||
| Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusFrom 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.1From 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.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-pat-01 | error | Patient | At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists() | |
| au-core-pat-02 | error | Patient | At least one patient name shall have a family name : name.family.exists() | |
| au-core-pat-04 | error | Patient.name | At least text, family name, or given name shall be present : text.exists() or family.exists() or given.exists() | |
| 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() | |
| 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
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron