Australian Base Implementation Guide (AU Base 1.1.1)
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 RelatedPerson Profile [FMM Level 2]
This profile defines a related person administration details structure that includes core localisation concepts for use in an Australian context.
These definitions represent common data held in the RelatedPerson.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
Benedicte du Marche as a next of kin
Sarah Simmons as the mother of Suzanne Simmons
Bill Simmons as a father of Suzanne Simmons
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-relatedperson
This profile defines a related person administration details structure that includes core localisation concepts for use in an Australian context.
This profile builds on RelatedPerson.
This profile was published on Tue May 01 00:00:00 AEST 2018 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 |
|---|---|---|---|---|
  RelatedPerson | 0..* | RelatedPerson | A person related to a patient in an Australian healthcare context | |
  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..* | Coding | Individual Healthcare Identifier (IHI) Number Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status | |
| ihi-record-status | 0..* | 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 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 | ||
| relationship | 0..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | I | 0..* | RelatedPerson | A person related to a patient in an Australian healthcare context |
 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 | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ÎŁ | 0..* | (Slice Definition) | A human identifier for this person 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..* | Coding | Individual Healthcare Identifier (IHI) Number Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status | |
| ihi-record-status | 0..* | 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 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 related person's record is in active use |
| patient | ÎŁ | 1..1 | Reference(Patient) | The patient this person is related to |
| relationship | ÎŁ | 0..1 | CodeableConcept | The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) |
| name | ÎŁ | 0..* | HumanName | A name associated with the person |
| telecom | ÎŁ | 0..* | ContactPoint | A contact detail for the person |
| gender | ÎŁ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate | ÎŁ | 0..1 | date | The date on which the related person was born |
| address | ÎŁ | 0..* | Address | Address where the related person can be contacted or visited |
| photo | 0..* | Attachment | Image of the person | |
| period | 0..1 | Period | Period of time that this relationship is considered valid | |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person related to a patient in an Australian healthcare context | |
| 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..* | Coding | Individual Healthcare Identifier (IHI) Number Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status | |
| ihi-record-status | 0..* | 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 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 | ||
| relationship | 0..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | I | 0..* | RelatedPerson | A person related to a patient in an Australian healthcare context |
| 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 | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ÎŁ | 0..* | (Slice Definition) | A human identifier for this person 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..* | Coding | Individual Healthcare Identifier (IHI) Number Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status | |
| ihi-record-status | 0..* | 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 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 related person's record is in active use |
| patient | ÎŁ | 1..1 | Reference(Patient) | The patient this person is related to |
| relationship | ÎŁ | 0..1 | CodeableConcept | The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) |
| name | ÎŁ | 0..* | HumanName | A name associated with the person |
| telecom | ÎŁ | 0..* | ContactPoint | A contact detail for the person |
| gender | ÎŁ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate | ÎŁ | 0..1 | date | The date on which the related person was born |
| address | ÎŁ | 0..* | Address | Address where the related person can be contacted or visited |
| photo | 0..* | Attachment | Image of the person | |
| period | 0..1 | Period | Period of time that this relationship is considered valid | |
| 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-relatedperson
none defined
© AU Base 1.1.1 on FHIR STU3 (IG Publisher v3.0.2-11200) generated on Wed, Jan 22, 2020 10:17+1100. |
