Australian Base Profiles Implementation Guide
This page is part of the Australian Base IG (v0.4.0: R1 Draft) based on FHIR (HL7® FHIR® Standard) R3. The current version which supersedes this version is 6.0.0. For a full list of available versions, see the Directory of published versions. Page versions: R5 R4 R3
AU Base Patient Profile
This profile defines a patient administration details structure that includes core localisation concepts.
These definitions represent common data held in the Patient.identifier element.
The numerical identifier that uniquely identifies each individual in the Australian healthcare system.
The IHI identifier may also include extension properties IHI Status and IHI Record Status associated with the IHI value.
Person identifier, allocated by the Health Insurance Commission to eligible persons under the Medicare scheme, that appears on a Medicare card.
The Medicare card number should only be collected from persons eligible to receive health services that are to be funded by the Commonwealth government. The number should be reported to the appropriate government agency to reconcile payment for the service provided. The data should not be used by private sector organisations for any other purpose unless specifically authorised by law. For example, data linkage should not be carried out unless specifically authorised by law.
Medicare number may also include an expiry date associated with the number.
The data should not be used by private sector organisations for any purpose unless specifically authorised by law. For example, private sector organisations should not use the DVA file number for data linking unless specifically authorised by relevant privacy legislation.
DVA number may also include details of the specific card colour associated with the number.
All of the above mentioned cards use Centerlink Customer Reference Number.
A personal identifier assigned by Centrelink for the purposes of identifying people (and organisations) eligible for specific services, including some public health care services, such as oral health services.
The CRN should only be collected from persons eligible to receive health services that are to be funded by Centrelink. The number may be reported to a Centrelink agency to reconcile payment for the service provided. The data should not be used by private sector organisations for any purpose unless specifically authorised by law. For example, data linkage should not be carried out unless specifically authorised by law.
Definitions here describe extensions to the Patient resource.
This extension is added to hold the administrative indigenous status of an individual. The Commonwealth defintion of indigenous status is “An Aboriginal or Torres Strait Islander is a person of Aboriginal or Torres Strait Islander descent who identifies as an Aboriginal or Torres Strait Islander and is accepted as such by the community in which he or she lives”
Indigenous status is defined as a coded concept associated with the patient.
An extension to hold the indication of registration to the Close the Gap co-payment scheme status for the patient. The CTG PBS Co-payment Measure improves access to PBS medicines for eligible Aboriginal and Torres Strait Islanders living with, or at risk of, chronic disease.
An extension to record the time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.
Patient with IHI, Medicare Number, and Health Care Card
Patient with IHI and DVA Number
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-patient
Australian realm Patient profile
This profile builds on Patient.
This profile was published on Wed Sep 06 16:30:54 AEST 2017 as a draft by Health Level Seven Australia (Patient Administration).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
AU Base Patient profile contains:
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | 0..* | Australian Patient | ||
  identifier | Identifier | Slice: Unordered, Open by value:system, value:type | ||
| identifier | 0..1 | Identifier | National Individual Health Identifier | |
 type | 1..1 | CodeableConcept | Binding: v2 Identifier Type - AU Extended (extensible) | |
| coding | 0..1 | Coding | Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"NI"} | |
 text | 1..1 | string | Fixed Value: IHI | |
| system | 1..1 | uri | national namespace for ihi Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0 | |
| value | I | 1..1 | string | Individual Health Identifier number inv-ihi-0: IHI shall be an exactly 16 digit number inv-ihi-1: IHI prefix is 800360 inv-ihi-2: IHI shall pass the Luhn algorithm check Example IHI number': 8003608166690503 Max Length: 16 |
 ihi-status | 0..* | Coding | IHI Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status Binding: Individual Healthcare Identifier Status (IHI Status) (required) | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/ihi-status" | |
| ihi-record-status | 0..* | Coding | IHI Record Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status Binding: Individual Healthcare Identifier Record Status (IHI Record Status) (required) | |
 url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/ihi-record-status" | |
| identifier | 0..* | Identifier | Medicare Number | |
| type | 1..1 | CodeableConcept | Binding: v2 Identifier Type - AU Extended (extensible) | |
| coding | 0..1 | Coding | Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"MC"} | |
| text | 1..1 | string | Fixed Value: Medicare Number | |
| system | 1..1 | uri | national namespace for medicare Fixed Value: http://ns.electronichealth.net.au/id/medicare-number | |
| value | 1..1 | string | Medicare Number value including optional individual reference number Example Medicare number': 32788511952 Max Length: 11 | |
| period | 1..1 | Period | ||
| end | 1..1 | dateTime | ||
| identifier | I | 0..1 | Identifier | DVA Number inv-dva-number-unspecified: DVA Number identifier type text must be 'DVA Number' when colour is not specified inv-dva-number-gold: DVA Number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG inv-dva-number-white: DVA Number identifier type text must be 'DVA Number (White)' when colour coding is DVW inv-dva-number-orange: DVA Number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO inv-dva-number-lilac: DVA Number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL inv-dva-number-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)' |
| type | 1..1 | CodeableConcept | Binding: v2 Identifier Type - AU Extended (extensible) | |
| coding | 0..1 | Coding | ||
| text | 1..1 | string | ||
| system | 1..1 | uri | DVA number identifier system Fixed Value: http://ns.electronichealth.net.au/id/dva | |
| value | 1..1 | string | DVA number value Example DVA number': NBUR9080 Max Length: 9 | |
| identifier | 0..1 | Identifier | Health Care Card Identifier | |
| type | 1..1 | CodeableConcept | Health Care Card Identifier Type Binding: v2 Identifier Type - AU Extended (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC"}],"text":"Health Care Card Number"} | |
| system | 1..1 | uri | namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/crn | |
| value | 1..1 | string | Centrelink Customer Reference Number (CRN) Example DHS CRN': 307111942H Max Length: 10 | |
| identifier | 0..1 | Identifier | Pensioner Concession Card Identifier | |
| type | 1..1 | CodeableConcept | Pensioner Concession Card Identifier Type Binding: v2 Identifier Type - AU Extended (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN"}],"text":"Pensioner Concession Card Number"} | |
| system | 1..1 | uri | namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/crn | |
| value | 1..1 | string | Centrelink Customer Reference Number (CRN) Example DHS CRN': 307111942H Max Length: 10 | |
| identifier | 0..1 | Identifier | Commonwealth Seniors Health Card Identifier | |
| type | 1..1 | CodeableConcept | Commonwealth Seniors Health Card Identifier Type Binding: v2 Identifier Type - AU Extended (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN"}],"text":"Commonwealth Seniors Health Card"} | |
| system | 1..1 | uri | namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/crn | |
| value | 1..1 | string | Centrelink Customer Reference Number (CRN) Example DHS CRN': 307111942H Max Length: 10 | |
| identifier | 0..* | Identifier | Medical Record Number | |
| type | 1..1 | CodeableConcept | Binding: v2 Identifier Type - AU Extended (extensible) | |
| coding | 1..1 | Coding | Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"MR"} | |
| text | 1..1 | string | Fixed Value: Medical Record Number | |
| system | 1..1 | uri | Medical recrord number system url | |
| value | 1..1 | string | Medical record number value | |
| assigner | 1..1 | Reference(Organization) | Medical recrord number assigning entity | |
| identifier | 0..* | Identifier | Private Health Insurance Member Number | |
| type | 1..1 | CodeableConcept | Binding: v2 Identifier Type - AU Extended (extensible) | |
| coding | 1..1 | Coding | Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"MB"} | |
| text | 1..1 | string | Fixed Value: Private Health Insurance Member Number | |
| value | 1..1 | string | Private health insurer member number | |
| assigner | 1..1 | Reference(Organization) | ||
| display | 1..1 | string | ||
| birthDate | 0..1 | date | Date of birth extended for time and accuracy indicator | |
| date-accuracy-indicator | 0..* | Coding | Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required) | |
| patient-birthTime | 0..* | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
| deceased[x] | boolean, dateTime | Slice: Unordered, Open by type:$this | ||
 deceased[x] | 0..1 | boolean | Boolean indicates if individual is deceased | |
| deceased[x] | 0..1 | dateTime | Indicates date-time the individual died | |
| date-accuracy-indicator | 0..* | Coding | Deceased date time accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required) | |
 generalPractitioner | 0..* | Reference(AU Base Practitioner), Reference(AU Base Organisation) | ||
| managingOrganization | 0..1 | Reference(AU Base Organisation) | ||
| indigenous-status | 0..* | Coding | Australian Indigenous Status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) | |
| close-the-gap-registration | 0..* | boolean | Close the Gap Registration URL: http://hl7.org.au/fhir/StructureDefinition/close-the-gap-registration | |
| birthPlace | 0..* | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/birthPlace | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | Australian Patient | |
| 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: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
| indigenous-status | 0..* | Coding | Australian Indigenous Status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) | |
| close-the-gap-registration | 0..* | boolean | Extension URL: http://hl7.org.au/fhir/StructureDefinition/close-the-gap-registration | |
| birthPlace | I | 0..* | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/birthPlace |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | Identifier | An identifier for this patient Slice: Unordered, Open by value:system, value:type | |
| identifier | Σ | 0..1 | Identifier | National Individual Health Identifier |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| ihi-status | 0..* | Coding | Extension URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status Binding: Individual Healthcare Identifier Status (IHI Status) (required) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/ihi-status" | |
| valueCoding | 1..1 | Coding | IHI Number Status Code Binding: Individual Healthcare Identifier Status (IHI Status) (required) | |
| ihi-record-status | 0..* | Coding | Extension URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status Binding: Individual Healthcare Identifier Record Status (IHI Record Status) (required) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/ihi-record-status" | |
| valueCoding | 1..1 | Coding | IHI Record Status Code Binding: Individual Healthcare Identifier Record Status (IHI Record Status) (required) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"NI"} |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: IHI |
| system | Σ | 1..1 | uri | national namespace for ihi Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0 |
| value | ΣI | 1..1 | string | Individual Health Identifier number inv-ihi-0: IHI shall be an exactly 16 digit number inv-ihi-1: IHI prefix is 800360 inv-ihi-2: IHI shall pass the Luhn algorithm check Example General': 123456 Example IHI number': 8003608166690503 Max Length: 16 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | Σ | 0..* | Identifier | Medicare Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"MC"} |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Medicare Number |
| system | Σ | 1..1 | uri | national namespace for medicare Fixed Value: http://ns.electronichealth.net.au/id/medicare-number |
| value | Σ | 1..1 | string | Medicare Number value including optional individual reference number Example General': 123456 Example Medicare number': 32788511952 Max Length: 11 |
| period | Σ | 1..1 | Period | Time period when id is/was valid for use |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary |
| end | ΣI | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..1 | Identifier | DVA Number inv-dva-number-unspecified: DVA Number identifier type text must be 'DVA Number' when colour is not specified inv-dva-number-gold: DVA Number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG inv-dva-number-white: DVA Number identifier type text must be 'DVA Number (White)' when colour coding is DVW inv-dva-number-orange: DVA Number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO inv-dva-number-lilac: DVA Number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL inv-dva-number-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)' |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| system | Σ | 1..1 | uri | DVA number identifier system Fixed Value: http://ns.electronichealth.net.au/id/dva |
| value | Σ | 1..1 | string | DVA number value Example General': 123456 Example DVA number': NBUR9080 Max Length: 9 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | Σ | 0..1 | Identifier | Health Care Card Identifier |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Health Care Card Identifier Type Binding: v2 Identifier Type - AU Extended (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC"}],"text":"Health Care Card Number"} |
| system | Σ | 1..1 | uri | namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/crn |
| value | Σ | 1..1 | string | Centrelink Customer Reference Number (CRN) Example General': 123456 Example DHS CRN': 307111942H Max Length: 10 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | Σ | 0..1 | Identifier | Pensioner Concession Card Identifier |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Pensioner Concession Card Identifier Type Binding: v2 Identifier Type - AU Extended (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN"}],"text":"Pensioner Concession Card Number"} |
| system | Σ | 1..1 | uri | namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/crn |
| value | Σ | 1..1 | string | Centrelink Customer Reference Number (CRN) Example General': 123456 Example DHS CRN': 307111942H Max Length: 10 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | Σ | 0..1 | Identifier | Commonwealth Seniors Health Card Identifier |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Commonwealth Seniors Health Card Identifier Type Binding: v2 Identifier Type - AU Extended (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN"}],"text":"Commonwealth Seniors Health Card"} |
| system | Σ | 1..1 | uri | namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/crn |
| value | Σ | 1..1 | string | Centrelink Customer Reference Number (CRN) Example General': 123456 Example DHS CRN': 307111942H Max Length: 10 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | Σ | 0..* | Identifier | Medical Record Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"MR"} |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Medical Record Number |
| system | Σ | 1..1 | uri | Medical recrord number system url Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| value | Σ | 1..1 | string | Medical record number value Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 1..1 | Reference(Organization) | Medical recrord number assigning entity |
| identifier | Σ | 0..* | Identifier | Private Health Insurance Member Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"MB"} |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Private Health Insurance Member Number |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| value | Σ | 1..1 | string | Private health insurer member number Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 1..1 | string | Text alternative for the resource |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | Σ | 0..* | HumanName | A name associated with the patient |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate | Σ | 0..1 | date | Date of birth extended for time and accuracy indicator |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| date-accuracy-indicator | 0..* | Coding | Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required) | |
| patient-birthTime | I | 0..* | dateTime | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
| value | 0..1 | Primitive value for date | ||
| deceased[x] | ?!Σ | boolean, dateTime | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |
| deceasedBoolean | ?!Σ | 0..1 | boolean | Boolean indicates if individual is deceased |
| deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates date-time the individual died |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| date-accuracy-indicator | 0..* | Coding | Deceased date time accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required) | |
| value | 0..1 | Primitive value for dateTime | ||
| address | Σ | 0..* | Address | Addresses for the individual |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) | |
 multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |
| photo | 0..* | Attachment | Image of the patient | |
| contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: v2 Contact Role (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 | Address for the contact person | |
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
| organization | I | 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 | |
| animal | ?!ΣI | 0..1 | BackboneElement | This patient is known to be an animal (non-human) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| species | Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example) |
| breed | Σ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreeds (example) |
| genderStatus | Σ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: GenderStatus (example) |
| communication | I | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages (extensible) | |
| preferred | 0..1 | boolean | Language preference indicator | |
| generalPractitioner | 0..* | Reference(AU Base Practitioner), Reference(AU Base Organisation) | Patient's nominated primary care provider | |
| managingOrganization | Σ | 0..1 | Reference(AU Base Organisation) | Organization that is the custodian of the patient record |
| link | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| other | Σ | 1..1 | Reference(Patient), Reference(RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required) |
| Documentation for this format | ||||
AU Base Patient profile contains:
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Australian Patient | ||
| identifier | Identifier | Slice: Unordered, Open by value:system, value:type | ||
| identifier | 0..1 | Identifier | National Individual Health Identifier | |
| type | 1..1 | CodeableConcept | Binding: v2 Identifier Type - AU Extended (extensible) | |
| coding | 0..1 | Coding | Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"NI"} | |
| text | 1..1 | string | Fixed Value: IHI | |
| system | 1..1 | uri | national namespace for ihi Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0 | |
| value | I | 1..1 | string | Individual Health Identifier number inv-ihi-0: IHI shall be an exactly 16 digit number inv-ihi-1: IHI prefix is 800360 inv-ihi-2: IHI shall pass the Luhn algorithm check Example IHI number': 8003608166690503 Max Length: 16 |
| ihi-status | 0..* | Coding | IHI Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status Binding: Individual Healthcare Identifier Status (IHI Status) (required) | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/ihi-status" | |
| ihi-record-status | 0..* | Coding | IHI Record Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status Binding: Individual Healthcare Identifier Record Status (IHI Record Status) (required) | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/ihi-record-status" | |
| identifier | 0..* | Identifier | Medicare Number | |
| type | 1..1 | CodeableConcept | Binding: v2 Identifier Type - AU Extended (extensible) | |
| coding | 0..1 | Coding | Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"MC"} | |
| text | 1..1 | string | Fixed Value: Medicare Number | |
| system | 1..1 | uri | national namespace for medicare Fixed Value: http://ns.electronichealth.net.au/id/medicare-number | |
| value | 1..1 | string | Medicare Number value including optional individual reference number Example Medicare number': 32788511952 Max Length: 11 | |
| period | 1..1 | Period | ||
| end | 1..1 | dateTime | ||
| identifier | I | 0..1 | Identifier | DVA Number inv-dva-number-unspecified: DVA Number identifier type text must be 'DVA Number' when colour is not specified inv-dva-number-gold: DVA Number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG inv-dva-number-white: DVA Number identifier type text must be 'DVA Number (White)' when colour coding is DVW inv-dva-number-orange: DVA Number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO inv-dva-number-lilac: DVA Number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL inv-dva-number-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)' |
| type | 1..1 | CodeableConcept | Binding: v2 Identifier Type - AU Extended (extensible) | |
| coding | 0..1 | Coding | ||
| text | 1..1 | string | ||
| system | 1..1 | uri | DVA number identifier system Fixed Value: http://ns.electronichealth.net.au/id/dva | |
| value | 1..1 | string | DVA number value Example DVA number': NBUR9080 Max Length: 9 | |
| identifier | 0..1 | Identifier | Health Care Card Identifier | |
| type | 1..1 | CodeableConcept | Health Care Card Identifier Type Binding: v2 Identifier Type - AU Extended (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC"}],"text":"Health Care Card Number"} | |
| system | 1..1 | uri | namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/crn | |
| value | 1..1 | string | Centrelink Customer Reference Number (CRN) Example DHS CRN': 307111942H Max Length: 10 | |
| identifier | 0..1 | Identifier | Pensioner Concession Card Identifier | |
| type | 1..1 | CodeableConcept | Pensioner Concession Card Identifier Type Binding: v2 Identifier Type - AU Extended (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN"}],"text":"Pensioner Concession Card Number"} | |
| system | 1..1 | uri | namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/crn | |
| value | 1..1 | string | Centrelink Customer Reference Number (CRN) Example DHS CRN': 307111942H Max Length: 10 | |
| identifier | 0..1 | Identifier | Commonwealth Seniors Health Card Identifier | |
| type | 1..1 | CodeableConcept | Commonwealth Seniors Health Card Identifier Type Binding: v2 Identifier Type - AU Extended (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN"}],"text":"Commonwealth Seniors Health Card"} | |
| system | 1..1 | uri | namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/crn | |
| value | 1..1 | string | Centrelink Customer Reference Number (CRN) Example DHS CRN': 307111942H Max Length: 10 | |
| identifier | 0..* | Identifier | Medical Record Number | |
| type | 1..1 | CodeableConcept | Binding: v2 Identifier Type - AU Extended (extensible) | |
| coding | 1..1 | Coding | Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"MR"} | |
| text | 1..1 | string | Fixed Value: Medical Record Number | |
| system | 1..1 | uri | Medical recrord number system url | |
| value | 1..1 | string | Medical record number value | |
| assigner | 1..1 | Reference(Organization) | Medical recrord number assigning entity | |
| identifier | 0..* | Identifier | Private Health Insurance Member Number | |
| type | 1..1 | CodeableConcept | Binding: v2 Identifier Type - AU Extended (extensible) | |
| coding | 1..1 | Coding | Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"MB"} | |
| text | 1..1 | string | Fixed Value: Private Health Insurance Member Number | |
| value | 1..1 | string | Private health insurer member number | |
| assigner | 1..1 | Reference(Organization) | ||
| display | 1..1 | string | ||
| birthDate | 0..1 | date | Date of birth extended for time and accuracy indicator | |
| date-accuracy-indicator | 0..* | Coding | Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required) | |
| patient-birthTime | 0..* | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
| deceased[x] | boolean, dateTime | Slice: Unordered, Open by type:$this | ||
| deceased[x] | 0..1 | boolean | Boolean indicates if individual is deceased | |
| deceased[x] | 0..1 | dateTime | Indicates date-time the individual died | |
| date-accuracy-indicator | 0..* | Coding | Deceased date time accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required) | |
| generalPractitioner | 0..* | Reference(AU Base Practitioner), Reference(AU Base Organisation) | ||
| managingOrganization | 0..1 | Reference(AU Base Organisation) | ||
| indigenous-status | 0..* | Coding | Australian Indigenous Status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) | |
| close-the-gap-registration | 0..* | boolean | Close the Gap Registration URL: http://hl7.org.au/fhir/StructureDefinition/close-the-gap-registration | |
| birthPlace | 0..* | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/birthPlace | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | Australian Patient | |
| 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: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| indigenous-status | 0..* | Coding | Australian Indigenous Status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) | |
| close-the-gap-registration | 0..* | boolean | Extension URL: http://hl7.org.au/fhir/StructureDefinition/close-the-gap-registration | |
| birthPlace | I | 0..* | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/birthPlace |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | Identifier | An identifier for this patient Slice: Unordered, Open by value:system, value:type | |
| identifier | Σ | 0..1 | Identifier | National Individual Health Identifier |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| ihi-status | 0..* | Coding | Extension URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status Binding: Individual Healthcare Identifier Status (IHI Status) (required) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/ihi-status" | |
| valueCoding | 1..1 | Coding | IHI Number Status Code Binding: Individual Healthcare Identifier Status (IHI Status) (required) | |
| ihi-record-status | 0..* | Coding | Extension URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status Binding: Individual Healthcare Identifier Record Status (IHI Record Status) (required) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/ihi-record-status" | |
| valueCoding | 1..1 | Coding | IHI Record Status Code Binding: Individual Healthcare Identifier Record Status (IHI Record Status) (required) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"NI"} |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: IHI |
| system | Σ | 1..1 | uri | national namespace for ihi Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0 |
| value | ΣI | 1..1 | string | Individual Health Identifier number inv-ihi-0: IHI shall be an exactly 16 digit number inv-ihi-1: IHI prefix is 800360 inv-ihi-2: IHI shall pass the Luhn algorithm check Example General': 123456 Example IHI number': 8003608166690503 Max Length: 16 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | Σ | 0..* | Identifier | Medicare Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"MC"} |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Medicare Number |
| system | Σ | 1..1 | uri | national namespace for medicare Fixed Value: http://ns.electronichealth.net.au/id/medicare-number |
| value | Σ | 1..1 | string | Medicare Number value including optional individual reference number Example General': 123456 Example Medicare number': 32788511952 Max Length: 11 |
| period | Σ | 1..1 | Period | Time period when id is/was valid for use |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary |
| end | ΣI | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..1 | Identifier | DVA Number inv-dva-number-unspecified: DVA Number identifier type text must be 'DVA Number' when colour is not specified inv-dva-number-gold: DVA Number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG inv-dva-number-white: DVA Number identifier type text must be 'DVA Number (White)' when colour coding is DVW inv-dva-number-orange: DVA Number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO inv-dva-number-lilac: DVA Number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL inv-dva-number-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)' |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| system | Σ | 1..1 | uri | DVA number identifier system Fixed Value: http://ns.electronichealth.net.au/id/dva |
| value | Σ | 1..1 | string | DVA number value Example General': 123456 Example DVA number': NBUR9080 Max Length: 9 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | Σ | 0..1 | Identifier | Health Care Card Identifier |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Health Care Card Identifier Type Binding: v2 Identifier Type - AU Extended (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC"}],"text":"Health Care Card Number"} |
| system | Σ | 1..1 | uri | namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/crn |
| value | Σ | 1..1 | string | Centrelink Customer Reference Number (CRN) Example General': 123456 Example DHS CRN': 307111942H Max Length: 10 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | Σ | 0..1 | Identifier | Pensioner Concession Card Identifier |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Pensioner Concession Card Identifier Type Binding: v2 Identifier Type - AU Extended (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN"}],"text":"Pensioner Concession Card Number"} |
| system | Σ | 1..1 | uri | namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/crn |
| value | Σ | 1..1 | string | Centrelink Customer Reference Number (CRN) Example General': 123456 Example DHS CRN': 307111942H Max Length: 10 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | Σ | 0..1 | Identifier | Commonwealth Seniors Health Card Identifier |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Commonwealth Seniors Health Card Identifier Type Binding: v2 Identifier Type - AU Extended (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN"}],"text":"Commonwealth Seniors Health Card"} |
| system | Σ | 1..1 | uri | namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/crn |
| value | Σ | 1..1 | string | Centrelink Customer Reference Number (CRN) Example General': 123456 Example DHS CRN': 307111942H Max Length: 10 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | Σ | 0..* | Identifier | Medical Record Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"MR"} |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Medical Record Number |
| system | Σ | 1..1 | uri | Medical recrord number system url Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| value | Σ | 1..1 | string | Medical record number value Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 1..1 | Reference(Organization) | Medical recrord number assigning entity |
| identifier | Σ | 0..* | Identifier | Private Health Insurance Member Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"MB"} |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Private Health Insurance Member Number |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| value | Σ | 1..1 | string | Private health insurer member number Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 1..1 | string | Text alternative for the resource |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | Σ | 0..* | HumanName | A name associated with the patient |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate | Σ | 0..1 | date | Date of birth extended for time and accuracy indicator |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| date-accuracy-indicator | 0..* | Coding | Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required) | |
| patient-birthTime | I | 0..* | dateTime | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
| value | 0..1 | Primitive value for date | ||
| deceased[x] | ?!Σ | boolean, dateTime | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |
| deceasedBoolean | ?!Σ | 0..1 | boolean | Boolean indicates if individual is deceased |
| deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates date-time the individual died |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| date-accuracy-indicator | 0..* | Coding | Deceased date time accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required) | |
| value | 0..1 | Primitive value for dateTime | ||
| address | Σ | 0..* | Address | Addresses for the individual |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) | |
| multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |
| photo | 0..* | Attachment | Image of the patient | |
| contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: v2 Contact Role (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 | Address for the contact person | |
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
| organization | I | 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 | |
| animal | ?!ΣI | 0..1 | BackboneElement | This patient is known to be an animal (non-human) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| species | Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example) |
| breed | Σ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreeds (example) |
| genderStatus | Σ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: GenderStatus (example) |
| communication | I | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages (extensible) | |
| preferred | 0..1 | boolean | Language preference indicator | |
| generalPractitioner | 0..* | Reference(AU Base Practitioner), Reference(AU Base Organisation) | Patient's nominated primary care provider | |
| managingOrganization | Σ | 0..1 | Reference(AU Base Organisation) | Organization that is the custodian of the patient record |
| link | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| other | Σ | 1..1 | Reference(Patient), Reference(RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required) |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-patient
none defined
AU Base © FHIR STU3 (IG Publisher v3.0.1-11917) generated on Thu, Nov 23, 2017 23:38+1100. |
