Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-emergency-contact-1 | Version: 1.0.0 | |||
Draft as of 2024-01-22 | Computable Name: ADHAPatientEmergencyContact | |||
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. This resource includes SNOMED Clinical Terms™ (SNOMED CT®) which is used by permission of the International Health Terminology Standards Development Organisation (IHTSDO). All rights reserved. SNOMED CT®, was originally created by The College of American Pathologists. “SNOMED” and “SNOMED CT” are registered trademarks of the IHTSDO. The rights to use and implement or implementation of SNOMED CT content are limited to the extent it is necessary to allow for the end use of this material. No further rights are granted in respect of the International Release and no further use of any SNOMED CT content by any other party is permitted. All copies of this resource must include this copyright statement and all information contained in this statement. |
The purpose of this profile is to support the exchange of patient emergency contact information between My Health App and My Health Record.
This profile derives from AU Core and is designed to My Health App requirements for the following functions:
Patient.contact
, with a value of 'emergency-contact'.Patient.contact.relationship.coding
is constrained to three types, 'Emergency Contact', 'Next of Kin' and 'Carer'.Patient.contact.relationship.text
contains additional information about the relationship between the emergency contact and the patient. If the emergency contact type is 'Emergency Contact' or 'Next of Kin', then there shall be an additional description, as shown in the Emergency Contact and Next of Kin examples. If the type is 'Carer', there will be no additional description, as shown in the Carer example.Patient.contact.relationship
are permitted. If an occurrence contains coding
then it shall not contain text
. The reverse also applies, i.e. if an occurrence contains text
then it shall not contain coding
.This profile may be referred to by APIs, which will be listed here when available.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUCorePatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information | |
Slices for contact | S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:extension('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1').value.system, value:extension('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1').value.code |
contact:mhr-ec | SC | 0..* | BackboneElement | This contact is an emergency contact inv-dh-pec-01: If a relationship is either 'Next of kin' or 'Emergency Contact', there shall be a second relationship representing additional information. inv-dh-pec-02: If a relationship is 'Carer', there shall not be a second relationship representing additional information. |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
special-processing | S | 1..1 | (Complex) | MHR special processing is relevent to the element URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1 |
valueCoding | S | 1..1 | Coding | Value of extension |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ns.electronichealth.net.au/fhir/CodeSystem/dh-mhr-special-processing-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: emergency-contact | |
Slices for relationship | S | 1..2 | CodeableConcept | The kind of relationship Slice: Unordered, Closed by exists:coding |
relationship:ec-type | S | 1..1 | CodeableConcept | The type of emergency contact Binding: Emergency Contact Type (required) |
coding | S | 1..1 | Coding | Code defined by a terminology system |
text | 0..0 | |||
relationship:ec-description | S | 0..1 | CodeableConcept | An additional description of the type of emergency contact |
coding | 0..0 | |||
text | S | 1..1 | string | Plain text representation of the concept |
name | S | 1..1 | HumanName | A name associated with the contact person |
Slices for telecom | S | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:system |
telecom:phone | S | 1..* | ContactPoint | A contact detail for the person |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
value | S | 1..1 | string | The actual contact point details |
telecom:email | S | 0..* | ContactPoint | A contact detail for the person |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
value | S | 1..1 | string | The actual contact point details |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.contact:mhr-ec.relationship:ec-type | required | EmergencyContactTypehttp://ns.electronichealth.net.au/fhir/ValueSet/emergency-contact-type-1 from this IG |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-pec-01 | error | Patient.contact:mhr-ec | If a relationship is either 'Next of kin' or 'Emergency Contact', there shall be a second relationship representing additional information. : relationship.where(coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0131' and code='C') or coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0131' and code='N')).exists() implies relationship.text.exists() | |
inv-dh-pec-02 | error | Patient.contact:mhr-ec | If a relationship is 'Carer', there shall not be a second relationship representing additional information. : relationship.where(coding.where(system='http://snomed.info/sct' and code='133932002').exists()).exists() implies relationship.text.empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
birthPlace | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
indigenousStatus | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||
veteranStatus | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
closingTheGapRegistration | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
mothersMaidenName | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
interpreterRequired | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
dateOfArrival | 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
genderIdentity | SOC | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||
individualPronouns | SOC | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||
recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
Slices for identifier | SOC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children
| ||||||
identifier:ihi | SOC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) ele-1: All FHIR elements must have a @value or children inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
| ||||||
identifier:medicare | SO | 0..1 | AUMedicareCardNumber | Medicare Card Number ele-1: All FHIR elements must have a @value or children
| ||||||
identifier:dva | SO | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number ele-1: All FHIR elements must have a @value or children
| ||||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children | ||||||
name | SOΣC | 1..* | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children au-core-pat-03: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
| ||||||
use | ?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
| ||||||
text | SOΣ | 0..1 | string | Text representation of the full name ele-1: All FHIR elements must have a @value or children
| ||||||
family | SOΣ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
| ||||||
given | SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
telecom | SOΣ | 0..* | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children
| ||||||
gender | SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
| ||||||
birthDate | SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator ele-1: All FHIR elements must have a @value or children
| ||||||
Slices for extension | Content/Rules for all slices | |||||||||
accuracyIndicator | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |||||||
deceasedBoolean | boolean | |||||||||
deceasedDateTime | dateTime | |||||||||
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator ele-1: All FHIR elements must have a @value or children | ||||||
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time ele-1: All FHIR elements must have a @value or children | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
accuracyIndicator | 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
address | SOC | 0..* | AustralianAddress, Address | An address for the individual ele-1: All FHIR elements must have a @value or children 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'
| ||||||
Slices for contact | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:extension('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1').value.system, value:extension('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1').value.code ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||||
contact:All Slices | Content/Rules for all slices | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
contact:mhr-ec | SC | 0..* | BackboneElement | This contact is an emergency contact ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization inv-dh-pec-01: If a relationship is either 'Next of kin' or 'Emergency Contact', there shall be a second relationship representing additional information. inv-dh-pec-02: If a relationship is 'Carer', there shall not be a second relationship representing additional information. | ||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
special-processing | S | 1..1 | (Complex) | MHR special processing is relevent to the element URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
url | 1..1 | uri | "http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1" | |||||||
Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this Binding: ADHA My Health Record Special Processing (required) ele-1: All FHIR elements must have a @value or children | |||||||
value[x]:valueCoding | S | 1..1 | Coding | Value of extension Binding: ADHA My Health Record Special Processing (required) ele-1: All FHIR elements must have a @value or children | ||||||
system | Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://ns.electronichealth.net.au/fhir/CodeSystem/dh-mhr-special-processing-1 | ||||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: emergency-contact | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
Slices for relationship | S | 1..2 | CodeableConcept | The kind of relationship Slice: Unordered, Closed by exists:coding Binding: Contact Relationship Type (extensible) ele-1: All FHIR elements must have a @value or children | ||||||
relationship:ec-type | S | 1..1 | CodeableConcept | The type of emergency contact Binding: Emergency Contact Type (required) ele-1: All FHIR elements must have a @value or children | ||||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children | ||||||
relationship:ec-description | S | 0..1 | CodeableConcept | An additional description of the type of emergency contact Binding: Contact Relationship Type (extensible) ele-1: All FHIR elements must have a @value or children | ||||||
text | SΣ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children | ||||||
name | S | 1..1 | HumanName | A name associated with the contact person ele-1: All FHIR elements must have a @value or children | ||||||
Slices for telecom | S | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children | ||||||
telecom:phone | S | 1..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children | ||||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: phone | ||||||
value | SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children | ||||||
telecom:email | S | 0..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children | ||||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: email | ||||||
value | SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children | ||||||
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children
| ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
language | SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible) ele-1: All FHIR elements must have a @value or children
| ||||||
preferred | SO | 0..1 | boolean | Language preference indicator ele-1: All FHIR elements must have a @value or children
| ||||||
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children | ||||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children | ||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | 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.contact:mhr-ec.extension:special-processing.value[x] | required | ADHAMyHealthRecordSpecialProcessing (a valid code from ADHA My Health Record Special Processing)http://ns.electronichealth.net.au/fhir/ValueSet/dh-mhr-special-processing-1 from this IG | |
Patient.contact:mhr-ec.extension:special-processing.value[x]:valueCoding | required | Fixed Value: emergency-contacthttp://ns.electronichealth.net.au/fhir/ValueSet/dh-mhr-special-processing-1 from this IG | |
Patient.contact:mhr-ec.relationship | extensible | ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | |
Patient.contact:mhr-ec.relationship:ec-type | required | EmergencyContactTypehttp://ns.electronichealth.net.au/fhir/ValueSet/emergency-contact-type-1 from this IG | |
Patient.contact:mhr-ec.relationship:ec-description | extensible | ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | |
Patient.contact:mhr-ec.telecom:phone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.contact:mhr-ec.telecom:phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.contact:mhr-ec.telecom:email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.contact:mhr-ec.telecom:email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|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 |
inv-dh-pec-01 | error | Patient.contact:mhr-ec | If a relationship is either 'Next of kin' or 'Emergency Contact', there shall be a second relationship representing additional information. : relationship.where(coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0131' and code='C') or coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0131' and code='N')).exists() implies relationship.text.exists() | |
inv-dh-pec-02 | error | Patient.contact:mhr-ec | If a relationship is 'Carer', there shall not be a second relationship representing additional information. : relationship.where(coding.where(system='http://snomed.info/sct' and code='133932002').exists()).exists() implies relationship.text.empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Patient | 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 | ||||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
contained | 0..* | Resource | Contained, inline Resources | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
birthPlace | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
indigenousStatus | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
| ||||||
veteranStatus | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required) | |||||||
closingTheGapRegistration | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||||
mothersMaidenName | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||
interpreterRequired | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||||
dateOfArrival | 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 | |||||||
genderIdentity | SOC | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
| ||||||
individualPronouns | SOC | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
| ||||||
recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
Slices for identifier | SOC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
identifier:ihi | SOC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
| ||||||
identifier:medicare | SO | 0..1 | AUMedicareCardNumber | Medicare Card Number
| ||||||
identifier:dva | SO | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
| ||||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
name | SOΣC | 1..* | HumanName | A name associated with the patient au-core-pat-03: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
use | ?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
text | SOΣ | 0..1 | string | Text representation of the full name
| ||||||
family | SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
given | SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||||
telecom | SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||
gender | SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
birthDate | SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
accuracyIndicator | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |||||||
birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
value | 0..1 | date | Primitive value for date | |||||||
Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
deceasedBoolean | boolean | |||||||||
deceasedDateTime | dateTime | |||||||||
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator | ||||||
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time | ||||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
accuracyIndicator | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |||||||
value | 0..1 | dateTime | Primitive value for dateTime | |||||||
address | SOC | 0..* | AustralianAddress, Address | An address for the individual inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
| ||||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||||
multipleBirthBoolean | boolean | |||||||||
multipleBirthInteger | integer | |||||||||
photo | 0..* | Attachment | Image of the patient | |||||||
Slices for contact | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:extension('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1').value.system, value:extension('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1').value.code pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||||
contact:All Slices | Content/Rules for all slices | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type (extensible) | |||||||
name | 0..1 | HumanName | A name associated with the contact person | |||||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||||
address | 0..1 | Address, AustralianAddress | Address for the contact person | |||||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||
contact:mhr-ec | SC | 0..* | BackboneElement | This contact is an emergency contact pat-1: SHALL at least contain a contact's details or a reference to an organization inv-dh-pec-01: If a relationship is either 'Next of kin' or 'Emergency Contact', there shall be a second relationship representing additional information. inv-dh-pec-02: If a relationship is 'Carer', there shall not be a second relationship representing additional information. | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
special-processing | S | 1..1 | (Complex) | MHR special processing is relevent to the element URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1 | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
url | 1..1 | uri | "http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1" | |||||||
Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this Binding: ADHA My Health Record Special Processing (required) | |||||||
value[x]:valueCoding | S | 1..1 | Coding | Value of extension Binding: ADHA My Health Record Special Processing (required) | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://ns.electronichealth.net.au/fhir/CodeSystem/dh-mhr-special-processing-1 | ||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: emergency-contact | ||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
Slices for relationship | S | 1..2 | CodeableConcept | The kind of relationship Slice: Unordered, Closed by exists:coding Binding: Contact Relationship Type (extensible) | ||||||
relationship:ec-type | S | 1..1 | CodeableConcept | The type of emergency contact Binding: Emergency Contact Type (required) | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||||
relationship:ec-description | S | 0..1 | CodeableConcept | An additional description of the type of emergency contact Binding: Contact Relationship Type (extensible) | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
text | SΣ | 1..1 | string | Plain text representation of the concept | ||||||
name | S | 1..1 | HumanName | A name associated with the contact person | ||||||
Slices for telecom | S | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:system | ||||||
telecom:phone | S | 1..* | ContactPoint | A contact detail for the person | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||||
value | SΣ | 1..1 | string | The actual contact point details | ||||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||
telecom:email | S | 0..* | ContactPoint | A contact detail for the person | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||||
value | SΣ | 1..1 | string | The actual contact point details | ||||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||
address | 0..1 | Address, AustralianAddress | Address for the contact person | |||||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
language | SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
| ||||||
preferred | SO | 0..1 | boolean | Language preference indicator
| ||||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||||
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.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.contact:mhr-ec.extension:special-processing.value[x] | required | ADHAMyHealthRecordSpecialProcessing (a valid code from ADHA My Health Record Special Processing)http://ns.electronichealth.net.au/fhir/ValueSet/dh-mhr-special-processing-1 from this IG | ||||
Patient.contact:mhr-ec.extension:special-processing.value[x]:valueCoding | required | Fixed Value: emergency-contacthttp://ns.electronichealth.net.au/fhir/ValueSet/dh-mhr-special-processing-1 from this IG | ||||
Patient.contact:mhr-ec.relationship | extensible | ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | ||||
Patient.contact:mhr-ec.relationship:ec-type | required | EmergencyContactTypehttp://ns.electronichealth.net.au/fhir/ValueSet/emergency-contact-type-1 from this IG | ||||
Patient.contact:mhr-ec.relationship:ec-description | extensible | ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | ||||
Patient.contact:mhr-ec.telecom:phone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.contact:mhr-ec.telecom:phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.contact:mhr-ec.telecom:email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.contact:mhr-ec.telecom:email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.contact:mhr-ec.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 |
inv-dh-pec-01 | error | Patient.contact:mhr-ec | If a relationship is either 'Next of kin' or 'Emergency Contact', there shall be a second relationship representing additional information. : relationship.where(coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0131' and code='C') or coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0131' and code='N')).exists() implies relationship.text.exists() | |
inv-dh-pec-02 | error | Patient.contact:mhr-ec | If a relationship is 'Carer', there shall not be a second relationship representing additional information. : relationship.where(coding.where(system='http://snomed.info/sct' and code='133932002').exists()).exists() implies relationship.text.empty() |
This structure is derived from AUCorePatient
Summary
Mandatory: 0 element(15 nested mandatory elements)
Must-Support: 17 elements
Fixed: 4 elements
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AUCorePatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information | |
Slices for contact | S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:extension('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1').value.system, value:extension('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1').value.code |
contact:mhr-ec | SC | 0..* | BackboneElement | This contact is an emergency contact inv-dh-pec-01: If a relationship is either 'Next of kin' or 'Emergency Contact', there shall be a second relationship representing additional information. inv-dh-pec-02: If a relationship is 'Carer', there shall not be a second relationship representing additional information. |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
special-processing | S | 1..1 | (Complex) | MHR special processing is relevent to the element URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1 |
valueCoding | S | 1..1 | Coding | Value of extension |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ns.electronichealth.net.au/fhir/CodeSystem/dh-mhr-special-processing-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: emergency-contact | |
Slices for relationship | S | 1..2 | CodeableConcept | The kind of relationship Slice: Unordered, Closed by exists:coding |
relationship:ec-type | S | 1..1 | CodeableConcept | The type of emergency contact Binding: Emergency Contact Type (required) |
coding | S | 1..1 | Coding | Code defined by a terminology system |
text | 0..0 | |||
relationship:ec-description | S | 0..1 | CodeableConcept | An additional description of the type of emergency contact |
coding | 0..0 | |||
text | S | 1..1 | string | Plain text representation of the concept |
name | S | 1..1 | HumanName | A name associated with the contact person |
Slices for telecom | S | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:system |
telecom:phone | S | 1..* | ContactPoint | A contact detail for the person |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
value | S | 1..1 | string | The actual contact point details |
telecom:email | S | 0..* | ContactPoint | A contact detail for the person |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
value | S | 1..1 | string | The actual contact point details |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.contact:mhr-ec.relationship:ec-type | required | EmergencyContactTypehttp://ns.electronichealth.net.au/fhir/ValueSet/emergency-contact-type-1 from this IG |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-pec-01 | error | Patient.contact:mhr-ec | If a relationship is either 'Next of kin' or 'Emergency Contact', there shall be a second relationship representing additional information. : relationship.where(coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0131' and code='C') or coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0131' and code='N')).exists() implies relationship.text.exists() | |
inv-dh-pec-02 | error | Patient.contact:mhr-ec | If a relationship is 'Carer', there shall not be a second relationship representing additional information. : relationship.where(coding.where(system='http://snomed.info/sct' and code='133932002').exists()).exists() implies relationship.text.empty() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | AUCorePatient | A patient in the context of electronic exchange of health information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
birthPlace | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
indigenousStatus | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||
veteranStatus | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
closingTheGapRegistration | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
mothersMaidenName | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
interpreterRequired | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
dateOfArrival | 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
genderIdentity | SOC | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||
individualPronouns | SOC | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||
recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
Slices for identifier | SOC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children
| ||||||
identifier:ihi | SOC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) ele-1: All FHIR elements must have a @value or children inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
| ||||||
identifier:medicare | SO | 0..1 | AUMedicareCardNumber | Medicare Card Number ele-1: All FHIR elements must have a @value or children
| ||||||
identifier:dva | SO | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number ele-1: All FHIR elements must have a @value or children
| ||||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children | ||||||
name | SOΣC | 1..* | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children au-core-pat-03: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
| ||||||
use | ?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
| ||||||
text | SOΣ | 0..1 | string | Text representation of the full name ele-1: All FHIR elements must have a @value or children
| ||||||
family | SOΣ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
| ||||||
given | SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
telecom | SOΣ | 0..* | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children
| ||||||
gender | SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
| ||||||
birthDate | SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator ele-1: All FHIR elements must have a @value or children
| ||||||
Slices for extension | Content/Rules for all slices | |||||||||
accuracyIndicator | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |||||||
deceasedBoolean | boolean | |||||||||
deceasedDateTime | dateTime | |||||||||
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator ele-1: All FHIR elements must have a @value or children | ||||||
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time ele-1: All FHIR elements must have a @value or children | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
accuracyIndicator | 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
address | SOC | 0..* | AustralianAddress, Address | An address for the individual ele-1: All FHIR elements must have a @value or children 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'
| ||||||
Slices for contact | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:extension('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1').value.system, value:extension('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1').value.code ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||||
contact:All Slices | Content/Rules for all slices | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
contact:mhr-ec | SC | 0..* | BackboneElement | This contact is an emergency contact ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization inv-dh-pec-01: If a relationship is either 'Next of kin' or 'Emergency Contact', there shall be a second relationship representing additional information. inv-dh-pec-02: If a relationship is 'Carer', there shall not be a second relationship representing additional information. | ||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||
special-processing | S | 1..1 | (Complex) | MHR special processing is relevent to the element URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
url | 1..1 | uri | "http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1" | |||||||
Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this Binding: ADHA My Health Record Special Processing (required) ele-1: All FHIR elements must have a @value or children | |||||||
value[x]:valueCoding | S | 1..1 | Coding | Value of extension Binding: ADHA My Health Record Special Processing (required) ele-1: All FHIR elements must have a @value or children | ||||||
system | Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://ns.electronichealth.net.au/fhir/CodeSystem/dh-mhr-special-processing-1 | ||||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: emergency-contact | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
Slices for relationship | S | 1..2 | CodeableConcept | The kind of relationship Slice: Unordered, Closed by exists:coding Binding: Contact Relationship Type (extensible) ele-1: All FHIR elements must have a @value or children | ||||||
relationship:ec-type | S | 1..1 | CodeableConcept | The type of emergency contact Binding: Emergency Contact Type (required) ele-1: All FHIR elements must have a @value or children | ||||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children | ||||||
relationship:ec-description | S | 0..1 | CodeableConcept | An additional description of the type of emergency contact Binding: Contact Relationship Type (extensible) ele-1: All FHIR elements must have a @value or children | ||||||
text | SΣ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children | ||||||
name | S | 1..1 | HumanName | A name associated with the contact person ele-1: All FHIR elements must have a @value or children | ||||||
Slices for telecom | S | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children | ||||||
telecom:phone | S | 1..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children | ||||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: phone | ||||||
value | SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children | ||||||
telecom:email | S | 0..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children | ||||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: email | ||||||
value | SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children | ||||||
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children
| ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
language | SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible) ele-1: All FHIR elements must have a @value or children
| ||||||
preferred | SO | 0..1 | boolean | Language preference indicator ele-1: All FHIR elements must have a @value or children
| ||||||
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children | ||||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children | ||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | 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.contact:mhr-ec.extension:special-processing.value[x] | required | ADHAMyHealthRecordSpecialProcessing (a valid code from ADHA My Health Record Special Processing)http://ns.electronichealth.net.au/fhir/ValueSet/dh-mhr-special-processing-1 from this IG | |
Patient.contact:mhr-ec.extension:special-processing.value[x]:valueCoding | required | Fixed Value: emergency-contacthttp://ns.electronichealth.net.au/fhir/ValueSet/dh-mhr-special-processing-1 from this IG | |
Patient.contact:mhr-ec.relationship | extensible | ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | |
Patient.contact:mhr-ec.relationship:ec-type | required | EmergencyContactTypehttp://ns.electronichealth.net.au/fhir/ValueSet/emergency-contact-type-1 from this IG | |
Patient.contact:mhr-ec.relationship:ec-description | extensible | ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | |
Patient.contact:mhr-ec.telecom:phone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.contact:mhr-ec.telecom:phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.contact:mhr-ec.telecom:email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.contact:mhr-ec.telecom:email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|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 |
inv-dh-pec-01 | error | Patient.contact:mhr-ec | If a relationship is either 'Next of kin' or 'Emergency Contact', there shall be a second relationship representing additional information. : relationship.where(coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0131' and code='C') or coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0131' and code='N')).exists() implies relationship.text.exists() | |
inv-dh-pec-02 | error | Patient.contact:mhr-ec | If a relationship is 'Carer', there shall not be a second relationship representing additional information. : relationship.where(coding.where(system='http://snomed.info/sct' and code='133932002').exists()).exists() implies relationship.text.empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Patient | 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 | ||||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
contained | 0..* | Resource | Contained, inline Resources | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
birthPlace | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||
indigenousStatus | SO | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
| ||||||
veteranStatus | 0..* | Coding | Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required) | |||||||
closingTheGapRegistration | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||||
mothersMaidenName | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||
interpreterRequired | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||||
dateOfArrival | 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 | |||||||
genderIdentity | SOC | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
| ||||||
individualPronouns | SOC | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
| ||||||
recordedSexOrGender | C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
Slices for identifier | SOC | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
| ||||||
identifier:ihi | SOC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
| ||||||
identifier:medicare | SO | 0..1 | AUMedicareCardNumber | Medicare Card Number
| ||||||
identifier:dva | SO | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number
| ||||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
name | SOΣC | 1..* | HumanName | A name associated with the patient au-core-pat-03: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
use | ?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
text | SOΣ | 0..1 | string | Text representation of the full name
| ||||||
family | SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
given | SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||||
telecom | SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||
gender | SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||
birthDate | SOΣC | 1..1 | date | Date of birth extended for time and accuracy indicator
| ||||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
accuracyIndicator | 0..1 | Coding | Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |||||||
birthTime | C | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||||
value | 0..1 | date | Primitive value for date | |||||||
Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||||
deceasedBoolean | boolean | |||||||||
deceasedDateTime | dateTime | |||||||||
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator | ||||||
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Deceased date time | ||||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
accuracyIndicator | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |||||||
value | 0..1 | dateTime | Primitive value for dateTime | |||||||
address | SOC | 0..* | AustralianAddress, Address | An address for the individual inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
| ||||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||||
multipleBirthBoolean | boolean | |||||||||
multipleBirthInteger | integer | |||||||||
photo | 0..* | Attachment | Image of the patient | |||||||
Slices for contact | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Slice: Unordered, Open by value:extension('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1').value.system, value:extension('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1').value.code pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||||
contact:All Slices | Content/Rules for all slices | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: Contact Relationship Type (extensible) | |||||||
name | 0..1 | HumanName | A name associated with the contact person | |||||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||||
address | 0..1 | Address, AustralianAddress | Address for the contact person | |||||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||
contact:mhr-ec | SC | 0..* | BackboneElement | This contact is an emergency contact pat-1: SHALL at least contain a contact's details or a reference to an organization inv-dh-pec-01: If a relationship is either 'Next of kin' or 'Emergency Contact', there shall be a second relationship representing additional information. inv-dh-pec-02: If a relationship is 'Carer', there shall not be a second relationship representing additional information. | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
special-processing | S | 1..1 | (Complex) | MHR special processing is relevent to the element URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1 | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
url | 1..1 | uri | "http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-special-processing-1" | |||||||
Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this Binding: ADHA My Health Record Special Processing (required) | |||||||
value[x]:valueCoding | S | 1..1 | Coding | Value of extension Binding: ADHA My Health Record Special Processing (required) | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://ns.electronichealth.net.au/fhir/CodeSystem/dh-mhr-special-processing-1 | ||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: emergency-contact | ||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
Slices for relationship | S | 1..2 | CodeableConcept | The kind of relationship Slice: Unordered, Closed by exists:coding Binding: Contact Relationship Type (extensible) | ||||||
relationship:ec-type | S | 1..1 | CodeableConcept | The type of emergency contact Binding: Emergency Contact Type (required) | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||||
relationship:ec-description | S | 0..1 | CodeableConcept | An additional description of the type of emergency contact Binding: Contact Relationship Type (extensible) | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
text | SΣ | 1..1 | string | Plain text representation of the concept | ||||||
name | S | 1..1 | HumanName | A name associated with the contact person | ||||||
Slices for telecom | S | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:system | ||||||
telecom:phone | S | 1..* | ContactPoint | A contact detail for the person | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||||
value | SΣ | 1..1 | string | The actual contact point details | ||||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||
telecom:email | S | 0..* | ContactPoint | A contact detail for the person | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||||
value | SΣ | 1..1 | string | The actual contact point details | ||||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||
address | 0..1 | Address, AustralianAddress | Address for the contact person | |||||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||
communication | SO | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
language | SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
| ||||||
preferred | SO | 0..1 | boolean | Language preference indicator
| ||||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||||
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.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.contact:mhr-ec.extension:special-processing.value[x] | required | ADHAMyHealthRecordSpecialProcessing (a valid code from ADHA My Health Record Special Processing)http://ns.electronichealth.net.au/fhir/ValueSet/dh-mhr-special-processing-1 from this IG | ||||
Patient.contact:mhr-ec.extension:special-processing.value[x]:valueCoding | required | Fixed Value: emergency-contacthttp://ns.electronichealth.net.au/fhir/ValueSet/dh-mhr-special-processing-1 from this IG | ||||
Patient.contact:mhr-ec.relationship | extensible | ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | ||||
Patient.contact:mhr-ec.relationship:ec-type | required | EmergencyContactTypehttp://ns.electronichealth.net.au/fhir/ValueSet/emergency-contact-type-1 from this IG | ||||
Patient.contact:mhr-ec.relationship:ec-description | extensible | ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | ||||
Patient.contact:mhr-ec.telecom:phone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.contact:mhr-ec.telecom:phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.contact:mhr-ec.telecom:email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.contact:mhr-ec.telecom:email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.contact:mhr-ec.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 |
inv-dh-pec-01 | error | Patient.contact:mhr-ec | If a relationship is either 'Next of kin' or 'Emergency Contact', there shall be a second relationship representing additional information. : relationship.where(coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0131' and code='C') or coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0131' and code='N')).exists() implies relationship.text.exists() | |
inv-dh-pec-02 | error | Patient.contact:mhr-ec | If a relationship is 'Carer', there shall not be a second relationship representing additional information. : relationship.where(coding.where(system='http://snomed.info/sct' and code='133932002').exists()).exists() implies relationship.text.empty() |
This structure is derived from AUCorePatient
Summary
Mandatory: 0 element(15 nested mandatory elements)
Must-Support: 17 elements
Fixed: 4 elements
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron