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

1.0 StructureDefinition-au-relatedperson

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.

Identifiers

These definitions represent common data held in the RelatedPerson.identifier element:

  • Individual Healthcare Identifier - IHI [1] [2]
  • Medicare Number [1] [2]
  • DVA (Department of Veterans’ Affairs) Number [1] [2]
  • Health Care Card Number, Pensioner Concession Card Number, Commonwealth Seniors Health Card Number [1] [2]
  • Medical Record Number [1] [2]
  • Private Health Insurance Member Number

Extensions

Extensions used in this profile:

  • RelatedPerson.identifier(IHI): IHI Status [1]
  • RelatedPerson.identifier(IHI): IHI Record Status [1]

Usage Notes

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

Mary Smith as a carer

Sarah Simmons as the mother of Suzanne Simmons

Bill Simmons as a father of Suzanne Simmons

1.0.1 Formal Views of Profile Content

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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonA person related to a patient in an Australian healthcare context
... identifier 0..*(Slice Definition)Slice: Unordered, Open by pattern:type, value:system
.... identifier:ihiNumber I0..*IdentifierNational 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..*ExtensionSlice: Unordered, Open by value:url
..... ihi-status 0..*CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
..... ihi-record-status 0..*CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
..... type 0..1CodeableConceptCoded identifier type for IHI
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NI
...... text 0..1stringFixed Value: IHI
..... system 1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
..... value 1..1stringIHI number
Example IHI number: 8003608833357361
Max Length: 16
.... identifier:medicareNumber 0..*IdentifierMedicare Number
..... type 0..1CodeableConceptCoded identifier type for Medicare number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MC
...... text 0..1stringFixed Value: Medicare Number
..... system 1..1uriNamespace for Medicare number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
..... value 1..1stringMedicare number including optional individual reference number
Example Medicare number: 32788511952
Max Length: 11
..... period 1..1PeriodMedicare number validity period
...... end 1..1dateTimeMedicare number expiry date
.... identifier:dvaNumber I0..*IdentifierDepartment 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..1CodeableConceptCoded identifier type for DVA number
Binding: v2 Identifier Type - AU Extended (required)
...... text 0..1string
..... system 1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
..... value 1..1stringDVA number
Example DVA number: NBUR9080
Max Length: 9
.... identifier:healthcareCard 0..*IdentifierHealth Care Card Number
..... type 1..1CodeableConceptCoded identifier type for Health Care Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HC
...... text 0..1stringFixed Value: Health Care Card Number
..... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value 1..1stringCentrelink CRN
Example DHS CRN: 307111942H
Max Length: 10
.... identifier:pensionerConcessionCard 0..*IdentifierPensioner Concession Card Number
..... type 1..1CodeableConceptCoded identifier type for Pensioner Concession Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PEN
...... text 0..1stringFixed Value: Pensioner Concession Card Number
..... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value 1..1stringCentrelink CRN
Example DHS CRN: 307111942H
Max Length: 10
.... identifier:commonwealthSeniorsHealthCard 0..*IdentifierCommonwealth Seniors Health Card Number
..... type 1..1CodeableConceptCoded identifier type for Commonwealth Seniors Health Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SEN
...... text 0..1stringFixed Value: Commonwealth Seniors Health Card
..... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value 1..1stringCentrelink CRN
Example DHS CRN: 307111942H
Max Length: 10
.... identifier:medicalRecordNumber 0..*IdentifierMedical Record Number (MRN)
..... type 1..1CodeableConceptCoded identifier type for MRN
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
...... text 0..1stringFixed Value: Medical Record Number
..... system 1..1uriMedical record number system namespace
..... value 1..1stringMedical record number
..... assigner 1..1Reference(Organization)Medical record number assigning entity
.... identifier:insurerNumber 0..*IdentifierPrivate Health Insurance Member Number
..... type 1..1CodeableConceptCoded identifier type for private health insurance member number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
...... text 0..1stringFixed Value: Private Health Insurance Member Number
..... value 1..1stringPrivate health insurance member number
..... assigner 1..1Reference(Organization)Private health insurer
...... display 1..1string
... relationship 0..1CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson I0..*RelatedPersonA person related to a patient in an Australian healthcare context
... id ÎŁ0..1idLogical id of this artifact
... meta ÎŁ0..1MetaMetadata about the resource
... implicitRules ?!ÎŁ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ÎŁ0..*(Slice Definition)A human identifier for this person
Slice: Unordered, Open by pattern:type, value:system
.... identifier:ihiNumber ÎŁI0..*IdentifierNational 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..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ihi-status 0..*CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
..... ihi-record-status 0..*CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ0..1CodeableConceptCoded identifier type for IHI
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NI
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: IHI
..... system ÎŁ1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
..... value ÎŁ1..1stringIHI number
Example General: 123456
Example IHI number: 8003608833357361
Max Length: 16
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:medicareNumber ÎŁ0..*IdentifierMedicare Number
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ0..1CodeableConceptCoded identifier type for Medicare number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: Medicare Number
..... system ÎŁ1..1uriNamespace for Medicare number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
..... value ÎŁ1..1stringMedicare number including optional individual reference number
Example General: 123456
Example Medicare number: 32788511952
Max Length: 11
..... period ÎŁ1..1PeriodMedicare number validity period
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... start ÎŁI0..1dateTimeStarting time with inclusive boundary
...... end ÎŁI1..1dateTimeMedicare number expiry date
..... assigner ÎŁ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dvaNumber ÎŁI0..*IdentifierDepartment 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..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ0..1CodeableConceptCoded identifier type for DVA number
Binding: v2 Identifier Type - AU Extended (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
..... system ÎŁ1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
..... value ÎŁ1..1stringDVA number
Example General: 123456
Example DVA number: NBUR9080
Max Length: 9
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:healthcareCard ÎŁ0..*IdentifierHealth Care Card Number
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ1..1CodeableConceptCoded identifier type for Health Care Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: Health Care Card Number
..... system ÎŁ1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value ÎŁ1..1stringCentrelink CRN
Example General: 123456
Example DHS CRN: 307111942H
Max Length: 10
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:pensionerConcessionCard ÎŁ0..*IdentifierPensioner Concession Card Number
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ1..1CodeableConceptCoded identifier type for Pensioner Concession Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PEN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: Pensioner Concession Card Number
..... system ÎŁ1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value ÎŁ1..1stringCentrelink CRN
Example General: 123456
Example DHS CRN: 307111942H
Max Length: 10
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:commonwealthSeniorsHealthCard ÎŁ0..*IdentifierCommonwealth Seniors Health Card Number
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ1..1CodeableConceptCoded identifier type for Commonwealth Seniors Health Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SEN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: Commonwealth Seniors Health Card
..... system ÎŁ1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value ÎŁ1..1stringCentrelink CRN
Example General: 123456
Example DHS CRN: 307111942H
Max Length: 10
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:medicalRecordNumber ÎŁ0..*IdentifierMedical Record Number (MRN)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ1..1CodeableConceptCoded identifier type for MRN
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: Medical Record Number
..... system ÎŁ1..1uriMedical record number system namespace
Example General: http://www.acme.com/identifiers/patient
..... value ÎŁ1..1stringMedical record number
Example General: 123456
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ1..1Reference(Organization)Medical record number assigning entity
.... identifier:insurerNumber ÎŁ0..*IdentifierPrivate Health Insurance Member Number
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ1..1CodeableConceptCoded identifier type for private health insurance member number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: Private Health Insurance Member Number
..... system ÎŁ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ÎŁ1..1stringPrivate health insurance member number
Example General: 123456
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ1..1Reference(Organization)Private health insurer
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... reference ÎŁI0..1stringLiteral reference, Relative, internal or absolute URL
...... identifier ÎŁ0..1IdentifierLogical reference, when literal reference is not known
...... display ÎŁ1..1stringText alternative for the resource
... active ?!ÎŁ0..1booleanWhether this related person's record is in active use
... patient ÎŁ1..1Reference(Patient)The patient this person is related to
... relationship ÎŁ0..1CodeableConceptThe nature of the relationship
Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
... name ÎŁ0..*HumanNameA name associated with the person
... telecom ÎŁ0..*ContactPointA contact detail for the person
... gender ÎŁ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ÎŁ0..1dateThe date on which the related person was born
... address ÎŁ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonA person related to a patient in an Australian healthcare context
... identifier 0..*(Slice Definition)Slice: Unordered, Open by pattern:type, value:system
.... identifier:ihiNumber I0..*IdentifierNational 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..*ExtensionSlice: Unordered, Open by value:url
..... ihi-status 0..*CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
..... ihi-record-status 0..*CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
..... type 0..1CodeableConceptCoded identifier type for IHI
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NI
...... text 0..1stringFixed Value: IHI
..... system 1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
..... value 1..1stringIHI number
Example IHI number: 8003608833357361
Max Length: 16
.... identifier:medicareNumber 0..*IdentifierMedicare Number
..... type 0..1CodeableConceptCoded identifier type for Medicare number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MC
...... text 0..1stringFixed Value: Medicare Number
..... system 1..1uriNamespace for Medicare number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
..... value 1..1stringMedicare number including optional individual reference number
Example Medicare number: 32788511952
Max Length: 11
..... period 1..1PeriodMedicare number validity period
...... end 1..1dateTimeMedicare number expiry date
.... identifier:dvaNumber I0..*IdentifierDepartment 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..1CodeableConceptCoded identifier type for DVA number
Binding: v2 Identifier Type - AU Extended (required)
...... text 0..1string
..... system 1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
..... value 1..1stringDVA number
Example DVA number: NBUR9080
Max Length: 9
.... identifier:healthcareCard 0..*IdentifierHealth Care Card Number
..... type 1..1CodeableConceptCoded identifier type for Health Care Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HC
...... text 0..1stringFixed Value: Health Care Card Number
..... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value 1..1stringCentrelink CRN
Example DHS CRN: 307111942H
Max Length: 10
.... identifier:pensionerConcessionCard 0..*IdentifierPensioner Concession Card Number
..... type 1..1CodeableConceptCoded identifier type for Pensioner Concession Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PEN
...... text 0..1stringFixed Value: Pensioner Concession Card Number
..... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value 1..1stringCentrelink CRN
Example DHS CRN: 307111942H
Max Length: 10
.... identifier:commonwealthSeniorsHealthCard 0..*IdentifierCommonwealth Seniors Health Card Number
..... type 1..1CodeableConceptCoded identifier type for Commonwealth Seniors Health Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SEN
...... text 0..1stringFixed Value: Commonwealth Seniors Health Card
..... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value 1..1stringCentrelink CRN
Example DHS CRN: 307111942H
Max Length: 10
.... identifier:medicalRecordNumber 0..*IdentifierMedical Record Number (MRN)
..... type 1..1CodeableConceptCoded identifier type for MRN
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
...... text 0..1stringFixed Value: Medical Record Number
..... system 1..1uriMedical record number system namespace
..... value 1..1stringMedical record number
..... assigner 1..1Reference(Organization)Medical record number assigning entity
.... identifier:insurerNumber 0..*IdentifierPrivate Health Insurance Member Number
..... type 1..1CodeableConceptCoded identifier type for private health insurance member number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
...... text 0..1stringFixed Value: Private Health Insurance Member Number
..... value 1..1stringPrivate health insurance member number
..... assigner 1..1Reference(Organization)Private health insurer
...... display 1..1string
... relationship 0..1CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson I0..*RelatedPersonA person related to a patient in an Australian healthcare context
... id ÎŁ0..1idLogical id of this artifact
... meta ÎŁ0..1MetaMetadata about the resource
... implicitRules ?!ÎŁ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ÎŁ0..*(Slice Definition)A human identifier for this person
Slice: Unordered, Open by pattern:type, value:system
.... identifier:ihiNumber ÎŁI0..*IdentifierNational 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..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ihi-status 0..*CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
..... ihi-record-status 0..*CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ0..1CodeableConceptCoded identifier type for IHI
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NI
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: IHI
..... system ÎŁ1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
..... value ÎŁ1..1stringIHI number
Example General: 123456
Example IHI number: 8003608833357361
Max Length: 16
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:medicareNumber ÎŁ0..*IdentifierMedicare Number
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ0..1CodeableConceptCoded identifier type for Medicare number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: Medicare Number
..... system ÎŁ1..1uriNamespace for Medicare number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
..... value ÎŁ1..1stringMedicare number including optional individual reference number
Example General: 123456
Example Medicare number: 32788511952
Max Length: 11
..... period ÎŁ1..1PeriodMedicare number validity period
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... start ÎŁI0..1dateTimeStarting time with inclusive boundary
...... end ÎŁI1..1dateTimeMedicare number expiry date
..... assigner ÎŁ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dvaNumber ÎŁI0..*IdentifierDepartment 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..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ0..1CodeableConceptCoded identifier type for DVA number
Binding: v2 Identifier Type - AU Extended (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
..... system ÎŁ1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
..... value ÎŁ1..1stringDVA number
Example General: 123456
Example DVA number: NBUR9080
Max Length: 9
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:healthcareCard ÎŁ0..*IdentifierHealth Care Card Number
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ1..1CodeableConceptCoded identifier type for Health Care Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: Health Care Card Number
..... system ÎŁ1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value ÎŁ1..1stringCentrelink CRN
Example General: 123456
Example DHS CRN: 307111942H
Max Length: 10
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:pensionerConcessionCard ÎŁ0..*IdentifierPensioner Concession Card Number
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ1..1CodeableConceptCoded identifier type for Pensioner Concession Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PEN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: Pensioner Concession Card Number
..... system ÎŁ1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value ÎŁ1..1stringCentrelink CRN
Example General: 123456
Example DHS CRN: 307111942H
Max Length: 10
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:commonwealthSeniorsHealthCard ÎŁ0..*IdentifierCommonwealth Seniors Health Card Number
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ1..1CodeableConceptCoded identifier type for Commonwealth Seniors Health Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SEN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: Commonwealth Seniors Health Card
..... system ÎŁ1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value ÎŁ1..1stringCentrelink CRN
Example General: 123456
Example DHS CRN: 307111942H
Max Length: 10
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:medicalRecordNumber ÎŁ0..*IdentifierMedical Record Number (MRN)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ1..1CodeableConceptCoded identifier type for MRN
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: Medical Record Number
..... system ÎŁ1..1uriMedical record number system namespace
Example General: http://www.acme.com/identifiers/patient
..... value ÎŁ1..1stringMedical record number
Example General: 123456
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ1..1Reference(Organization)Medical record number assigning entity
.... identifier:insurerNumber ÎŁ0..*IdentifierPrivate Health Insurance Member Number
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ÎŁ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type ÎŁ1..1CodeableConceptCoded identifier type for private health insurance member number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding ÎŁ0..*CodingCode defined by a terminology system
...... text ÎŁ0..1stringPlain text representation of the concept
Fixed Value: Private Health Insurance Member Number
..... system ÎŁ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ÎŁ1..1stringPrivate health insurance member number
Example General: 123456
..... period ÎŁ0..1PeriodTime period when id is/was valid for use
..... assigner ÎŁ1..1Reference(Organization)Private health insurer
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... reference ÎŁI0..1stringLiteral reference, Relative, internal or absolute URL
...... identifier ÎŁ0..1IdentifierLogical reference, when literal reference is not known
...... display ÎŁ1..1stringText alternative for the resource
... active ?!ÎŁ0..1booleanWhether this related person's record is in active use
... patient ÎŁ1..1Reference(Patient)The patient this person is related to
... relationship ÎŁ0..1CodeableConceptThe nature of the relationship
Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
... name ÎŁ0..*HumanNameA name associated with the person
... telecom ÎŁ0..*ContactPointA contact detail for the person
... gender ÎŁ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ÎŁ0..1dateThe date on which the related person was born
... address ÎŁ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-relatedperson

none defined