This page is part of the Australian Base IG (v1.1.1: AU Base 1.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
AU Base Patient Profile [FMM Level 3]
This profile defines a patient administration details structure that includes core localisation concepts for use in an Australian context.
These definitions represent common data held in the Patient.identifier element:
Extensions used in this profile:
Mutiple Individual Healthcare Identifiers are supported particularly to support the recording of IHI values where the status and/or record status varies (e.g. deceased, provisional).
Medicare Number is defined as a 10 or 11 digit number. Whilst 10 digits is not sufficient to uniquely identify an individual it is a supported entry where systems do not support 11 digit content. If required profiles can constrain this slice further to restrict usage to 11 digits only as desired. Medicare Numbers are not used for uniquely identifying patients, they are identifying information that can be used in conjunction with other elements such as name and date of birth appropriately to confirm identity.
Examples
Patient with IHI, Medicare Number, and Health Care Card
Patient with IHI and DVA Number
Patient with no birth date, and eligible for Closing the Gap registration
Patient Sarah Simmons linked to related person Sarah Simmons
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-patient
This profile defines a patient administration details structure that includes core localisation concepts for use in an Australian context.
This profile builds on Patient.
This profile was published on Wed Mar 06 10:07:00 AEDT 2019 as a active by Health Level Seven Australia (Patient Administration WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | I | 0..* | Patient | A patient in an Australian healthcare context inv-pat-0: If there is a birth time its date shall be the birth date |
extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
birthPlace | 0..1 | Address | Patient Birth Place URL: http://hl7.org/fhir/StructureDefinition/birthPlace | |
indigenous-status | 0..1 | Coding | Patient Indigenous Status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status | |
closing-the-gap-registration | 0..1 | boolean | Patient Closing the Gap Program Eligibility Indication URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |
patient-mothersMaidenName | 0..1 | string | Patient Mother's Maiden Name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |
identifier | 0..* | (Slice Definition) | Slice: Unordered, Open by pattern:type, value:system | |
identifier:ihiNumber | I | 0..* | Identifier | National Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check |
extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
ihi-status | 0..1 | Coding | Individual Healthcare Identifier (IHI) Number Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status | |
ihi-record-status | 0..1 | Coding | Individual Healthcare Identifier (IHI) Number Record Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status | |
type | 0..1 | CodeableConcept | Coded identifier type for IHI Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | |
text | 0..1 | string | Fixed Value: IHI | |
system | 1..1 | uri | Namespace for IHI Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0 | |
value | 1..1 | string | IHI number Example IHI number: 8003608833357361 Max Length: 16 | |
identifier:medicareNumber | 0..* | Identifier | Medicare Number | |
type | 0..1 | CodeableConcept | Coded identifier type for Medicare number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MC | |
text | 0..1 | string | Fixed Value: Medicare Number | |
system | 1..1 | uri | Namespace for Medicare number Fixed Value: http://ns.electronichealth.net.au/id/medicare-number | |
value | 1..1 | string | Medicare number including optional individual reference number Example Medicare number: 32788511952 Max Length: 11 | |
period | 1..1 | Period | Medicare number validity period | |
end | 1..1 | dateTime | Medicare number expiry date | |
identifier:dvaNumber | I | 0..* | Identifier | Department of Veterans' Affairs (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 | 0..1 | CodeableConcept | Coded identifier type for DVA number Binding: v2 Identifier Type - AU Extended (required) | |
text | 0..1 | string | ||
system | 1..1 | uri | Namespace for DVA number Fixed Value: http://ns.electronichealth.net.au/id/dva | |
value | 1..1 | string | DVA number Example Department of Veterans' Affairs (DVA) number: NBUR9080 Max Length: 9 | |
identifier:healthcareCard | 0..* | Identifier | Health Care Card Number | |
type | 1..1 | CodeableConcept | Coded identifier type for Health Care Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HC | |
text | 0..1 | string | Fixed Value: Health Care Card Number | |
system | 1..1 | uri | Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number | |
value | 1..1 | string | Centrelink CRN Example DHS CRN: 307111942H Max Length: 10 | |
identifier:pensionerConcessionCard | 0..* | Identifier | Pensioner Concession Card Number | |
type | 1..1 | CodeableConcept | Coded identifier type for Pensioner Concession Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PEN | |
text | 0..1 | string | Fixed Value: Pensioner Concession Card Number | |
system | 1..1 | uri | Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number | |
value | 1..1 | string | Centrelink CRN Example DHS CRN: 307111942H Max Length: 10 | |
identifier:commonwealthSeniorsHealthCard | 0..* | Identifier | Commonwealth Seniors Health Card Number | |
type | 1..1 | CodeableConcept | Coded identifier type for Commonwealth Seniors Health Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SEN | |
text | 0..1 | string | Fixed Value: Commonwealth Seniors Health Card | |
system | 1..1 | uri | Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number | |
value | 1..1 | string | Centrelink CRN Example DHS CRN: 307111942H Max Length: 10 | |
identifier:medicalRecordNumber | 0..* | Identifier | Medical Record Number (MRN) | |
type | 1..1 | CodeableConcept | Coded identifier type for MRN Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
text | 0..1 | string | Fixed Value: Medical Record Number | |
system | 1..1 | uri | Medical record number system namespace | |
value | 1..1 | string | Medical record number | |
assigner | 1..1 | Reference(Organization) | Medical record number assigning entity | |
identifier:insurerNumber | 0..* | Identifier | Private Health Insurance Member Number | |
type | 1..1 | CodeableConcept | Coded identifier type for private health insurance member number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |
text | 0..1 | string | Fixed Value: Private Health Insurance Member Number | |
value | 1..1 | string | Private health insurance member number | |
assigner | 1..1 | Reference(Organization) | Private health insurer | |
display | 1..1 | string | ||
birthDate | 0..1 | date | Date of birth extended for time and accuracy indicator | |
extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
date-accuracy-indicator | 0..1 | Coding | Birth Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator | |
patient-birthTime | 0..1 | dateTime | Birth Time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
deceased[x] | 0..1 | (Slice Definition) | Slice: Unordered, Closed by type:$this | |
deceased[x]:deceasedBoolean | 0..1 | boolean | Deceased Indicator | |
deceased[x]:deceasedDateTime | 0..1 | dateTime | Deceased Date Time | |
extension | 0..1 | Extension | Slice: Unordered, Open by value:url | |
date-accuracy-indicator | 0..1 | Coding | Deceased Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator | |
communication | 0..* | BackboneElement | ||
language | 1..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | I | 0..* | Patient | A patient in an Australian healthcare context inv-pat-0: If there is a birth time its date shall be the birth date |
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) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthPlace | I | 0..1 | Address | Patient Birth Place URL: http://hl7.org/fhir/StructureDefinition/birthPlace |
indigenous-status | I | 0..1 | Coding | Patient Indigenous Status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status |
closing-the-gap-registration | I | 0..1 | boolean | Patient Closing the Gap Program Eligibility Indication URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration |
patient-mothersMaidenName | I | 0..1 | string | Patient Mother's Maiden Name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ÎŁ | 0..* | (Slice Definition) | An identifier for this patient Slice: Unordered, Open by pattern:type, value:system |
identifier:ihiNumber | ÎŁI | 0..* | Identifier | National Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ihi-status | 0..1 | Coding | Individual Healthcare Identifier (IHI) Number Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status | |
ihi-record-status | 0..1 | Coding | Individual Healthcare Identifier (IHI) Number Record Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 0..1 | CodeableConcept | Coded identifier type for IHI Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept Fixed Value: IHI |
system | ÎŁ | 1..1 | uri | Namespace for IHI Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0 |
value | ÎŁ | 1..1 | string | IHI number Example General: 123456 Example IHI number: 8003608833357361 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:medicareNumber | ÎŁ | 0..* | Identifier | Medicare Number |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 0..1 | CodeableConcept | Coded identifier type for Medicare number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MC | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept Fixed Value: Medicare Number |
system | ÎŁ | 1..1 | uri | Namespace for Medicare number Fixed Value: http://ns.electronichealth.net.au/id/medicare-number |
value | ÎŁ | 1..1 | string | Medicare number including optional individual reference number Example General: 123456 Example Medicare number: 32788511952 Max Length: 11 |
period | ÎŁ | 1..1 | Period | Medicare number validity period |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
start | ÎŁI | 0..1 | dateTime | Starting time with inclusive boundary |
end | ÎŁI | 1..1 | dateTime | Medicare number expiry date |
assigner | ÎŁ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
identifier:dvaNumber | ÎŁI | 0..* | Identifier | Department of Veterans' Affairs (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) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 0..1 | CodeableConcept | Coded identifier type for DVA number Binding: v2 Identifier Type - AU Extended (required) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept |
system | ÎŁ | 1..1 | uri | Namespace for DVA number Fixed Value: http://ns.electronichealth.net.au/id/dva |
value | ÎŁ | 1..1 | string | DVA number Example General: 123456 Example Department of Veterans' Affairs (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:healthcareCard | ÎŁ | 0..* | Identifier | Health Care Card Number |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 1..1 | CodeableConcept | Coded identifier type for Health Care Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HC | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept Fixed Value: Health Care Card Number |
system | ÎŁ | 1..1 | uri | Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number |
value | ÎŁ | 1..1 | string | Centrelink 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:pensionerConcessionCard | ÎŁ | 0..* | Identifier | Pensioner Concession Card Number |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 1..1 | CodeableConcept | Coded identifier type for Pensioner Concession Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PEN | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept Fixed Value: Pensioner Concession Card Number |
system | ÎŁ | 1..1 | uri | Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number |
value | ÎŁ | 1..1 | string | Centrelink 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:commonwealthSeniorsHealthCard | ÎŁ | 0..* | Identifier | Commonwealth Seniors Health Card Number |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 1..1 | CodeableConcept | Coded identifier type for Commonwealth Seniors Health Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SEN | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept Fixed Value: Commonwealth Seniors Health Card |
system | ÎŁ | 1..1 | uri | Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number |
value | ÎŁ | 1..1 | string | Centrelink 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:medicalRecordNumber | ÎŁ | 0..* | Identifier | Medical Record Number (MRN) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 1..1 | CodeableConcept | Coded identifier type for MRN Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept Fixed Value: Medical Record Number |
system | ÎŁ | 1..1 | uri | Medical record number system namespace Example General: http://www.acme.com/identifiers/patient |
value | ÎŁ | 1..1 | string | Medical record number Example General: 123456 |
period | ÎŁ | 0..1 | Period | Time period when id is/was valid for use |
assigner | ÎŁ | 1..1 | Reference(Organization) | Medical record number assigning entity |
identifier:insurerNumber | ÎŁ | 0..* | Identifier | Private Health Insurance Member Number |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 1..1 | CodeableConcept | Coded identifier type for private health insurance member number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..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 |
value | ÎŁ | 1..1 | string | Private health insurance member number Example General: 123456 |
period | ÎŁ | 0..1 | Period | Time period when id is/was valid for use |
assigner | ÎŁ | 1..1 | Reference(Organization) | Private health insurer |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
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) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
date-accuracy-indicator | I | 0..1 | Coding | Birth Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator |
patient-birthTime | I | 0..1 | dateTime | Birth Time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
value | 0..1 | date | Primitive value for date | |
deceased[x] | ?!ÎŁ | 0..1 | (Slice Definition) | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
deceased[x]:deceasedBoolean | ?!ÎŁ | 0..1 | boolean | Deceased Indicator |
deceased[x]:deceasedDateTime | ?!ÎŁ | 0..1 | dateTime | Deceased Date Time |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..1 | Extension | Extension Slice: Unordered, Open by value:url | |
date-accuracy-indicator | I | 0..1 | Coding | Deceased Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator |
value | 0..1 | dateTime | 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 | Whether patient is part of a multiple birth | ||
multipleBirthBoolean | boolean | |||
multipleBirthInteger | integer | |||
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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | 0..* | Reference(Organization | 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 | 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 |
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | I | 0..* | Patient | A patient in an Australian healthcare context inv-pat-0: If there is a birth time its date shall be the birth date |
extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
birthPlace | 0..1 | Address | Patient Birth Place URL: http://hl7.org/fhir/StructureDefinition/birthPlace | |
indigenous-status | 0..1 | Coding | Patient Indigenous Status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status | |
closing-the-gap-registration | 0..1 | boolean | Patient Closing the Gap Program Eligibility Indication URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |
patient-mothersMaidenName | 0..1 | string | Patient Mother's Maiden Name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |
identifier | 0..* | (Slice Definition) | Slice: Unordered, Open by pattern:type, value:system | |
identifier:ihiNumber | I | 0..* | Identifier | National Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check |
extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
ihi-status | 0..1 | Coding | Individual Healthcare Identifier (IHI) Number Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status | |
ihi-record-status | 0..1 | Coding | Individual Healthcare Identifier (IHI) Number Record Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status | |
type | 0..1 | CodeableConcept | Coded identifier type for IHI Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | |
text | 0..1 | string | Fixed Value: IHI | |
system | 1..1 | uri | Namespace for IHI Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0 | |
value | 1..1 | string | IHI number Example IHI number: 8003608833357361 Max Length: 16 | |
identifier:medicareNumber | 0..* | Identifier | Medicare Number | |
type | 0..1 | CodeableConcept | Coded identifier type for Medicare number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MC | |
text | 0..1 | string | Fixed Value: Medicare Number | |
system | 1..1 | uri | Namespace for Medicare number Fixed Value: http://ns.electronichealth.net.au/id/medicare-number | |
value | 1..1 | string | Medicare number including optional individual reference number Example Medicare number: 32788511952 Max Length: 11 | |
period | 1..1 | Period | Medicare number validity period | |
end | 1..1 | dateTime | Medicare number expiry date | |
identifier:dvaNumber | I | 0..* | Identifier | Department of Veterans' Affairs (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 | 0..1 | CodeableConcept | Coded identifier type for DVA number Binding: v2 Identifier Type - AU Extended (required) | |
text | 0..1 | string | ||
system | 1..1 | uri | Namespace for DVA number Fixed Value: http://ns.electronichealth.net.au/id/dva | |
value | 1..1 | string | DVA number Example Department of Veterans' Affairs (DVA) number: NBUR9080 Max Length: 9 | |
identifier:healthcareCard | 0..* | Identifier | Health Care Card Number | |
type | 1..1 | CodeableConcept | Coded identifier type for Health Care Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HC | |
text | 0..1 | string | Fixed Value: Health Care Card Number | |
system | 1..1 | uri | Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number | |
value | 1..1 | string | Centrelink CRN Example DHS CRN: 307111942H Max Length: 10 | |
identifier:pensionerConcessionCard | 0..* | Identifier | Pensioner Concession Card Number | |
type | 1..1 | CodeableConcept | Coded identifier type for Pensioner Concession Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PEN | |
text | 0..1 | string | Fixed Value: Pensioner Concession Card Number | |
system | 1..1 | uri | Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number | |
value | 1..1 | string | Centrelink CRN Example DHS CRN: 307111942H Max Length: 10 | |
identifier:commonwealthSeniorsHealthCard | 0..* | Identifier | Commonwealth Seniors Health Card Number | |
type | 1..1 | CodeableConcept | Coded identifier type for Commonwealth Seniors Health Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SEN | |
text | 0..1 | string | Fixed Value: Commonwealth Seniors Health Card | |
system | 1..1 | uri | Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number | |
value | 1..1 | string | Centrelink CRN Example DHS CRN: 307111942H Max Length: 10 | |
identifier:medicalRecordNumber | 0..* | Identifier | Medical Record Number (MRN) | |
type | 1..1 | CodeableConcept | Coded identifier type for MRN Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
text | 0..1 | string | Fixed Value: Medical Record Number | |
system | 1..1 | uri | Medical record number system namespace | |
value | 1..1 | string | Medical record number | |
assigner | 1..1 | Reference(Organization) | Medical record number assigning entity | |
identifier:insurerNumber | 0..* | Identifier | Private Health Insurance Member Number | |
type | 1..1 | CodeableConcept | Coded identifier type for private health insurance member number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |
text | 0..1 | string | Fixed Value: Private Health Insurance Member Number | |
value | 1..1 | string | Private health insurance member number | |
assigner | 1..1 | Reference(Organization) | Private health insurer | |
display | 1..1 | string | ||
birthDate | 0..1 | date | Date of birth extended for time and accuracy indicator | |
extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
date-accuracy-indicator | 0..1 | Coding | Birth Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator | |
patient-birthTime | 0..1 | dateTime | Birth Time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
deceased[x] | 0..1 | (Slice Definition) | Slice: Unordered, Closed by type:$this | |
deceased[x]:deceasedBoolean | 0..1 | boolean | Deceased Indicator | |
deceased[x]:deceasedDateTime | 0..1 | dateTime | Deceased Date Time | |
extension | 0..1 | Extension | Slice: Unordered, Open by value:url | |
date-accuracy-indicator | 0..1 | Coding | Deceased Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator | |
communication | 0..* | BackboneElement | ||
language | 1..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | I | 0..* | Patient | A patient in an Australian healthcare context inv-pat-0: If there is a birth time its date shall be the birth date |
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) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthPlace | I | 0..1 | Address | Patient Birth Place URL: http://hl7.org/fhir/StructureDefinition/birthPlace |
indigenous-status | I | 0..1 | Coding | Patient Indigenous Status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status |
closing-the-gap-registration | I | 0..1 | boolean | Patient Closing the Gap Program Eligibility Indication URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration |
patient-mothersMaidenName | I | 0..1 | string | Patient Mother's Maiden Name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ÎŁ | 0..* | (Slice Definition) | An identifier for this patient Slice: Unordered, Open by pattern:type, value:system |
identifier:ihiNumber | ÎŁI | 0..* | Identifier | National Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ihi-status | 0..1 | Coding | Individual Healthcare Identifier (IHI) Number Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status | |
ihi-record-status | 0..1 | Coding | Individual Healthcare Identifier (IHI) Number Record Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 0..1 | CodeableConcept | Coded identifier type for IHI Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept Fixed Value: IHI |
system | ÎŁ | 1..1 | uri | Namespace for IHI Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0 |
value | ÎŁ | 1..1 | string | IHI number Example General: 123456 Example IHI number: 8003608833357361 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:medicareNumber | ÎŁ | 0..* | Identifier | Medicare Number |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 0..1 | CodeableConcept | Coded identifier type for Medicare number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MC | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept Fixed Value: Medicare Number |
system | ÎŁ | 1..1 | uri | Namespace for Medicare number Fixed Value: http://ns.electronichealth.net.au/id/medicare-number |
value | ÎŁ | 1..1 | string | Medicare number including optional individual reference number Example General: 123456 Example Medicare number: 32788511952 Max Length: 11 |
period | ÎŁ | 1..1 | Period | Medicare number validity period |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
start | ÎŁI | 0..1 | dateTime | Starting time with inclusive boundary |
end | ÎŁI | 1..1 | dateTime | Medicare number expiry date |
assigner | ÎŁ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
identifier:dvaNumber | ÎŁI | 0..* | Identifier | Department of Veterans' Affairs (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) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 0..1 | CodeableConcept | Coded identifier type for DVA number Binding: v2 Identifier Type - AU Extended (required) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept |
system | ÎŁ | 1..1 | uri | Namespace for DVA number Fixed Value: http://ns.electronichealth.net.au/id/dva |
value | ÎŁ | 1..1 | string | DVA number Example General: 123456 Example Department of Veterans' Affairs (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:healthcareCard | ÎŁ | 0..* | Identifier | Health Care Card Number |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 1..1 | CodeableConcept | Coded identifier type for Health Care Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HC | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept Fixed Value: Health Care Card Number |
system | ÎŁ | 1..1 | uri | Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number |
value | ÎŁ | 1..1 | string | Centrelink 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:pensionerConcessionCard | ÎŁ | 0..* | Identifier | Pensioner Concession Card Number |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 1..1 | CodeableConcept | Coded identifier type for Pensioner Concession Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PEN | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept Fixed Value: Pensioner Concession Card Number |
system | ÎŁ | 1..1 | uri | Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number |
value | ÎŁ | 1..1 | string | Centrelink 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:commonwealthSeniorsHealthCard | ÎŁ | 0..* | Identifier | Commonwealth Seniors Health Card Number |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 1..1 | CodeableConcept | Coded identifier type for Commonwealth Seniors Health Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SEN | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept Fixed Value: Commonwealth Seniors Health Card |
system | ÎŁ | 1..1 | uri | Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number |
value | ÎŁ | 1..1 | string | Centrelink 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:medicalRecordNumber | ÎŁ | 0..* | Identifier | Medical Record Number (MRN) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 1..1 | CodeableConcept | Coded identifier type for MRN Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..1 | string | Plain text representation of the concept Fixed Value: Medical Record Number |
system | ÎŁ | 1..1 | uri | Medical record number system namespace Example General: http://www.acme.com/identifiers/patient |
value | ÎŁ | 1..1 | string | Medical record number Example General: 123456 |
period | ÎŁ | 0..1 | Period | Time period when id is/was valid for use |
assigner | ÎŁ | 1..1 | Reference(Organization) | Medical record number assigning entity |
identifier:insurerNumber | ÎŁ | 0..* | Identifier | Private Health Insurance Member Number |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!ÎŁ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ÎŁ | 1..1 | CodeableConcept | Coded identifier type for private health insurance member number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | ÎŁ | 0..* | Coding | Code defined by a terminology system |
text | ÎŁ | 0..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 |
value | ÎŁ | 1..1 | string | Private health insurance member number Example General: 123456 |
period | ÎŁ | 0..1 | Period | Time period when id is/was valid for use |
assigner | ÎŁ | 1..1 | Reference(Organization) | Private health insurer |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
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) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
date-accuracy-indicator | I | 0..1 | Coding | Birth Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator |
patient-birthTime | I | 0..1 | dateTime | Birth Time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
value | 0..1 | date | Primitive value for date | |
deceased[x] | ?!ÎŁ | 0..1 | (Slice Definition) | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
deceased[x]:deceasedBoolean | ?!ÎŁ | 0..1 | boolean | Deceased Indicator |
deceased[x]:deceasedDateTime | ?!ÎŁ | 0..1 | dateTime | Deceased Date Time |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..1 | Extension | Extension Slice: Unordered, Open by value:url | |
date-accuracy-indicator | I | 0..1 | Coding | Deceased Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator |
value | 0..1 | dateTime | 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 | Whether patient is part of a multiple birth | ||
multipleBirthBoolean | boolean | |||
multipleBirthInteger | integer | |||
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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | 0..* | Reference(Organization | 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 | 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