Australian Base Profiles Implementation Guide
This page is part of the Australian Base IG (v0.1.0: AU Base 1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions 
Australian Human Patient Profile
This profile defines a patient administration details structure that includes core localisation concepts.
This definition is for human patients only, for non-human patients it is recommended the base Patient resource definition be used.
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.
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 Sat Mar 11 17:30:54 AEDT 2017 as a draft by Health Level Seven Australia (Patient Administration).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Australian Patient Profile contains:
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | 0..* | |||
  identifier | Identifier | Slice: Unordered, Open At End by value:system, value:type | ||
 identifier | I | 0..1 | Identifier | National Individual Health Identifier inv-ihi-0: IHI is exactly 16 characters inv-ihi-1: IHI prefix is 800360 |
 type | 1..1 | CodeableConcept | ||
| coding | 0..1 | Coding | Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"NI","display":"National unique individual identifier"} | |
  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 | 1..1 | string | Individual Health Identifier number Example IHI number': 8003608166690503 Max Length: 16 | |
 extension-au-ihi-status | 0..1 | Coding | IHI Number Status URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-status Binding: Individual Healthcare Identifier Status (IHI Status) (required) | |
| extension-au-ihi-record-status | 0..1 | Coding | IHI Record Status URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-record-status Binding: Individual Healthcare Identifier Record Status (IHI Record Status) (required) | |
| identifier | 0..1 | Identifier | Medicare Number | |
| type | 1..1 | CodeableConcept | ||
| coding | 0..1 | Coding | Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"MC","display":"Patient's Medicare Number"} | |
| 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-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange)' |
| type | 1..1 | CodeableConcept | ||
| coding | 0..1 | Coding | Binding: v2 Identifier Type - AU Extended - DVA Specifc Card Types (required) | |
| 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 Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC","display":"Health Card Number"}],"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 Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN","display":"Pension Number"}],"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 Fixed Value: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN","display":"Commonwealth Seniors Health Card"}],"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 | |
| animal | 0..0 | |||
| indigenous-status | 0..1 | Coding | Australian Indigenous Status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | Information about an individual or animal receiving health care services | |
| 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..1 | Coding | Australian Indigenous Status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | Identifier | An identifier for this patient Slice: Unordered, Open At End by value:system, value:type | |
| identifier | ΣI | 0..1 | Identifier | National Individual Health Identifier inv-ihi-0: IHI is exactly 16 characters inv-ihi-1: IHI prefix is 800360 |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension-au-ihi-status | 0..1 | Coding | IHI Number Status URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-status Binding: Individual Healthcare Identifier Status (IHI Status) (required) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | identifies the meaning of the extension | |
 value[x] | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of extension | |
| extension-au-ihi-record-status | 0..1 | Coding | IHI Record Status URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-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 | identifies the meaning of the extension | |
| value[x] | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of extension | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"NI","display":"National unique individual identifier"} |
| 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 | Σ | 1..1 | string | Individual Health Identifier number 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..1 | 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: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"MC","display":"Patient's Medicare Number"} |
| 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-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange)' |
| 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: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Binding: v2 Identifier Type - AU Extended - DVA Specifc Card Types (required) |
| 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: Identifier Type Codes (extensible) Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC","display":"Health Card Number"}],"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: Identifier Type Codes (extensible) Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN","display":"Pension Number"}],"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: Identifier Type Codes (extensible) Fixed Value: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN","display":"Commonwealth Seniors Health Card"}],"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) |
| 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 | The date of birth for the individual |
| deceased[x] | ?!Σ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
| 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 | |
| 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(Organization), Reference(Practitioner) | Patient's nominated primary care provider | |
| managingOrganization | Σ | 0..1 | Reference(Organization) | 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 | ||||
Australian Patient Profile contains:
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | |||
| identifier | Identifier | Slice: Unordered, Open At End by value:system, value:type | ||
| identifier | I | 0..1 | Identifier | National Individual Health Identifier inv-ihi-0: IHI is exactly 16 characters inv-ihi-1: IHI prefix is 800360 |
| type | 1..1 | CodeableConcept | ||
| coding | 0..1 | Coding | Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"NI","display":"National unique individual identifier"} | |
| 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 | 1..1 | string | Individual Health Identifier number Example IHI number': 8003608166690503 Max Length: 16 | |
| extension-au-ihi-status | 0..1 | Coding | IHI Number Status URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-status Binding: Individual Healthcare Identifier Status (IHI Status) (required) | |
| extension-au-ihi-record-status | 0..1 | Coding | IHI Record Status URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-record-status Binding: Individual Healthcare Identifier Record Status (IHI Record Status) (required) | |
| identifier | 0..1 | Identifier | Medicare Number | |
| type | 1..1 | CodeableConcept | ||
| coding | 0..1 | Coding | Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"MC","display":"Patient's Medicare Number"} | |
| 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-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange)' |
| type | 1..1 | CodeableConcept | ||
| coding | 0..1 | Coding | Binding: v2 Identifier Type - AU Extended - DVA Specifc Card Types (required) | |
| 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 Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC","display":"Health Card Number"}],"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 Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN","display":"Pension Number"}],"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 Fixed Value: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN","display":"Commonwealth Seniors Health Card"}],"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 | |
| animal | 0..0 | |||
| indigenous-status | 0..1 | Coding | Australian Indigenous Status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | Information about an individual or animal receiving health care services | |
| 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..1 | Coding | Australian Indigenous Status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | Identifier | An identifier for this patient Slice: Unordered, Open At End by value:system, value:type | |
| identifier | ΣI | 0..1 | Identifier | National Individual Health Identifier inv-ihi-0: IHI is exactly 16 characters inv-ihi-1: IHI prefix is 800360 |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension-au-ihi-status | 0..1 | Coding | IHI Number Status URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-status Binding: Individual Healthcare Identifier Status (IHI Status) (required) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | identifies the meaning of the extension | |
| value[x] | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of extension | |
| extension-au-ihi-record-status | 0..1 | Coding | IHI Record Status URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-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 | identifies the meaning of the extension | |
| value[x] | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of extension | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"NI","display":"National unique individual identifier"} |
| 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 | Σ | 1..1 | string | Individual Health Identifier number 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..1 | 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: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"MC","display":"Patient's Medicare Number"} |
| 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-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange)' |
| 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: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Binding: v2 Identifier Type - AU Extended - DVA Specifc Card Types (required) |
| 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: Identifier Type Codes (extensible) Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC","display":"Health Card Number"}],"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: Identifier Type Codes (extensible) Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN","display":"Pension Number"}],"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: Identifier Type Codes (extensible) Fixed Value: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN","display":"Commonwealth Seniors Health Card"}],"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) |
| 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 | The date of birth for the individual |
| deceased[x] | ?!Σ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
| 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 | |
| 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(Organization), Reference(Practitioner) | Patient's nominated primary care provider | |
| managingOrganization | Σ | 0..1 | Reference(Organization) | 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, May 4, 2017 23:40+1000. |
