Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.9.3: R1 Draft) based on FHIR (HL7® FHIR® Standard) R3. The current version which supersedes this version is 6.0.0. For a full list of available versions, see the Directory of published versions. Page versions: R5 R4 R3

1.0 StructureDefinition-au-relatedperson

AU Base RelatedPerson Profile [FMM Level 0]

This profile defines a related person administration details structure that includes core localisation concepts.

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]

Extensions

Extensions used in this profile:

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

Examples

Benedicte du Marche as a next of kin

Mary Smith as a carer

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-relatedperson

Australian realm RelatedPerson resource.

This profile builds on RelatedPerson.

This profile was published on Tue May 01 00:00:00 AEST 2018 as a draft by Health Level Seven Australia (Patient Administration WG).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This profile contains the following variations from RelatedPerson:

  1. zero or more identifier sliced
    • at most one identifier National Individual Health Identifier
      • at most one ihiStatus extension
      • at most one ihiRecordStatus extension
    • zero or more identifier Medicare Number
    • at most one identifier DVA Number
    • at most one identifier Health Care Card Identifier
    • at most one identifier Pensioner Concession Card Identifier
    • at most one identifier Commonwealth Seniors Health Card Identifier
    • zero or more identifier Medical Record Number
    • zero or more identifier Private Health Insurance Member Number
  2. exactly one patient Patient record this person relates to (Reference as: au-patient)
  3. at most one relationship
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*A person related to a patient in an Australian healthcare context
... identifier IdentifierSlice: Unordered, Open by value:system, value:type
... identifier 0..1IdentifierNational Individual Health Identifier
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... ihi-status 0..1CodingIHI Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
.... ihi-record-status 0..1CodingIHI Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
.... type 1..1CodeableConceptCoded identifier type for IHI
Binding: v2 Identifier Type - AU Extended (required)
..... coding 0..1Coding
...... system 1..1uriRequired system
Fixed Value: http://hl7.org/fhir/v2/0203
...... code 1..1codeFixed Value: NI
..... text 1..1stringFixed Value: IHI
.... system 1..1urinational namespace for ihi
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
.... value I1..1stringIndividual Health Identifier number
inv-ihi-0: IHI shall be an exactly 16 digit number
inv-ihi-1: IHI prefix is 800360
inv-ihi-2: IHI shall pass the Luhn algorithm check
Example IHI number': 8003608166690503
Max Length: 16
... identifier 0..*IdentifierMedicare Number
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding 0..1Coding
...... system 1..1uriFixed Value: http://hl7.org/fhir/v2/0203
...... code 1..1codeFixed Value: MC
..... text 1..1stringFixed Value: Medicare Number
.... system 1..1urinational namespace for medicare
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
.... value 1..1stringMedicare Number value including optional individual reference number
Example Medicare number': 32788511952
Max Length: 11
.... period 1..1PeriodMedicare validity period
..... end 1..1dateTimeMedicare Expiry Date
... identifier I0..1IdentifierDVA Number
inv-dva-number-unspecified: DVA Number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA Number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG
inv-dva-number-white: DVA Number identifier type text must be 'DVA Number (White)' when colour coding is DVW
inv-dva-number-orange: DVA Number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO
inv-dva-number-lilac: DVA Number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL
inv-dva-number-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)'
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding I0..1Codinginv-dva-number-coding: DVA colour coding must be DVL, DVW, DVO or DVG
..... text 1..1string
.... system 1..1uriDVA number identifier system
Fixed Value: http://ns.electronichealth.net.au/id/dva
.... value 1..1stringDVA number value
Example DVA number': NBUR9080
Max Length: 9
... identifier 0..1IdentifierHealth Care Card Identifier
.... type 1..1CodeableConceptHealth Care Card Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
..... coding 0..1Coding
...... system 1..1uriFixed Value: http://hl7.org/fhir/v2/0203
...... code 1..1codeFixed Value: HC
..... text 1..1stringFixed Value: Health Care Card Number
.... system 1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value 1..1stringCentrelink Customer Reference Number (CRN)
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..1IdentifierPensioner Concession Card Identifier
.... type 1..1CodeableConceptPensioner Concession Card Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
..... coding 0..1Coding
...... system 1..1uriFixed Value: http://hl7.org/fhir/v2/0203
...... code 1..1codeFixed Value: PEN
..... text 1..1stringFixed Value: Pensioner Concession Card Number
.... system 1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value 1..1stringCentrelink Customer Reference Number (CRN)
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..1IdentifierCommonwealth Seniors Health Card Identifier
.... type 1..1CodeableConceptCommonwealth Seniors Health Card Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"text":"Commonwealth Seniors Health Card"}
..... coding 0..1Coding
...... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
...... code 1..1codeFixed Value: SEN
..... text 1..1stringFixed Value: Commonwealth Seniors Health Card
.... system 1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value 1..1stringCentrelink Customer Reference Number (CRN)
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..*IdentifierMedical Record Number
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding 1..1Coding
...... system 1..1uriFixed Value: http://hl7.org/fhir/v2/0203
...... code 1..1codeFixed Value: MR
..... text 1..1stringFixed Value: Medical Record Number
.... system 1..1uriMedical record number system url
.... value 1..1stringMedical record number value
.... assigner 1..1Reference(Organization)Medical record number assigning entity
... identifier 0..*IdentifierPrivate Health Insurance Member Number
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding 1..1Coding
...... system 1..1uriFixed Value: http://hl7.org/fhir/v2/0203
...... code 1..1codeFixed Value: MB
..... text 1..1stringFixed Value: Private Health Insurance Member Number
.... value 1..1stringPrivate health insurer member number
.... assigner 1..1Reference(Organization)
..... display 1..1string
... patient 1..1Reference(AU Base Patient)Patient record this person relates to
... 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..*A 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)
... 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 ΣIdentifierA human identifier for this person
Slice: Unordered, Open by value:system, value:type
... identifier Σ0..1IdentifierNational Individual Health Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ihi-status 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ihi-status"
..... valueCoding 1..1CodingIHI Number Status Code
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
.... ihi-record-status 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ihi-record-status"
..... valueCoding 1..1CodingIHI Record Status Code
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCoded identifier type for IHI
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..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriRequired system
Fixed Value: http://hl7.org/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: NI
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: IHI
.... system Σ1..1urinational namespace for ihi
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
.... value ΣI1..1stringIndividual Health Identifier number
inv-ihi-0: IHI shall be an exactly 16 digit number
inv-ihi-1: IHI prefix is 800360
inv-ihi-2: IHI shall pass the Luhn algorithm check
Example General': 123456
Example IHI number': 8003608166690503
Max Length: 16
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ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 Σ1..1CodeableConceptDescription of identifier
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..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: MC
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Medicare Number
.... system Σ1..1urinational namespace for medicare
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
.... value Σ1..1stringMedicare Number value including optional individual reference number
Example General': 123456
Example Medicare number': 32788511952
Max Length: 11
.... period Σ1..1PeriodMedicare 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 Expiry Date
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier ΣI0..1IdentifierDVA 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 Σ1..1CodeableConceptDescription of identifier
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 ΣI0..1CodingCode defined by a terminology system
inv-dva-number-coding: DVA colour coding must be DVL, DVW, DVO or DVG
..... text Σ1..1stringPlain text representation of the concept
.... system Σ1..1uriDVA number identifier system
Fixed Value: http://ns.electronichealth.net.au/id/dva
.... value Σ1..1stringDVA number value
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 Σ0..1IdentifierHealth Care Card Identifier
.... 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..1CodeableConceptHealth Care Card Identifier Type
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..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: HC
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Health Care Card Number
.... system Σ1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value Σ1..1stringCentrelink Customer Reference Number (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 Σ0..1IdentifierPensioner Concession Card Identifier
.... 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..1CodeableConceptPensioner Concession Card Identifier Type
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..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: PEN
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Pensioner Concession Card Number
.... system Σ1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value Σ1..1stringCentrelink Customer Reference Number (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 Σ0..1IdentifierCommonwealth Seniors Health Card Identifier
.... 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..1CodeableConceptCommonwealth Seniors Health Card Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"text":"Commonwealth Seniors Health Card"}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: SEN
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Commonwealth Seniors Health Card
.... system Σ1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value Σ1..1stringCentrelink Customer Reference Number (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 Σ0..*IdentifierMedical Record 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..1CodeableConceptDescription of identifier
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 Σ1..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: MR
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Medical Record Number
.... system Σ1..1uriMedical record number system url
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringMedical record number value
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Medical record number assigning entity
... identifier Σ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..1CodeableConceptDescription of identifier
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 Σ1..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: MB
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..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 or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringPrivate health insurer member number
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Organization that issued id (may be just text)
..... 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(AU Base Patient)Patient record this person relates 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

This profile contains the following variations from RelatedPerson:

  1. zero or more identifier sliced
    • at most one identifier National Individual Health Identifier
      • at most one ihiStatus extension
      • at most one ihiRecordStatus extension
    • zero or more identifier Medicare Number
    • at most one identifier DVA Number
    • at most one identifier Health Care Card Identifier
    • at most one identifier Pensioner Concession Card Identifier
    • at most one identifier Commonwealth Seniors Health Card Identifier
    • zero or more identifier Medical Record Number
    • zero or more identifier Private Health Insurance Member Number
  2. exactly one patient Patient record this person relates to (Reference as: au-patient)
  3. at most one relationship

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*A person related to a patient in an Australian healthcare context
... identifier IdentifierSlice: Unordered, Open by value:system, value:type
... identifier 0..1IdentifierNational Individual Health Identifier
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... ihi-status 0..1CodingIHI Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
.... ihi-record-status 0..1CodingIHI Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
.... type 1..1CodeableConceptCoded identifier type for IHI
Binding: v2 Identifier Type - AU Extended (required)
..... coding 0..1Coding
...... system 1..1uriRequired system
Fixed Value: http://hl7.org/fhir/v2/0203
...... code 1..1codeFixed Value: NI
..... text 1..1stringFixed Value: IHI
.... system 1..1urinational namespace for ihi
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
.... value I1..1stringIndividual Health Identifier number
inv-ihi-0: IHI shall be an exactly 16 digit number
inv-ihi-1: IHI prefix is 800360
inv-ihi-2: IHI shall pass the Luhn algorithm check
Example IHI number': 8003608166690503
Max Length: 16
... identifier 0..*IdentifierMedicare Number
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding 0..1Coding
...... system 1..1uriFixed Value: http://hl7.org/fhir/v2/0203
...... code 1..1codeFixed Value: MC
..... text 1..1stringFixed Value: Medicare Number
.... system 1..1urinational namespace for medicare
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
.... value 1..1stringMedicare Number value including optional individual reference number
Example Medicare number': 32788511952
Max Length: 11
.... period 1..1PeriodMedicare validity period
..... end 1..1dateTimeMedicare Expiry Date
... identifier I0..1IdentifierDVA Number
inv-dva-number-unspecified: DVA Number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA Number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG
inv-dva-number-white: DVA Number identifier type text must be 'DVA Number (White)' when colour coding is DVW
inv-dva-number-orange: DVA Number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO
inv-dva-number-lilac: DVA Number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL
inv-dva-number-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)'
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding I0..1Codinginv-dva-number-coding: DVA colour coding must be DVL, DVW, DVO or DVG
..... text 1..1string
.... system 1..1uriDVA number identifier system
Fixed Value: http://ns.electronichealth.net.au/id/dva
.... value 1..1stringDVA number value
Example DVA number': NBUR9080
Max Length: 9
... identifier 0..1IdentifierHealth Care Card Identifier
.... type 1..1CodeableConceptHealth Care Card Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
..... coding 0..1Coding
...... system 1..1uriFixed Value: http://hl7.org/fhir/v2/0203
...... code 1..1codeFixed Value: HC
..... text 1..1stringFixed Value: Health Care Card Number
.... system 1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value 1..1stringCentrelink Customer Reference Number (CRN)
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..1IdentifierPensioner Concession Card Identifier
.... type 1..1CodeableConceptPensioner Concession Card Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
..... coding 0..1Coding
...... system 1..1uriFixed Value: http://hl7.org/fhir/v2/0203
...... code 1..1codeFixed Value: PEN
..... text 1..1stringFixed Value: Pensioner Concession Card Number
.... system 1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value 1..1stringCentrelink Customer Reference Number (CRN)
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..1IdentifierCommonwealth Seniors Health Card Identifier
.... type 1..1CodeableConceptCommonwealth Seniors Health Card Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"text":"Commonwealth Seniors Health Card"}
..... coding 0..1Coding
...... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
...... code 1..1codeFixed Value: SEN
..... text 1..1stringFixed Value: Commonwealth Seniors Health Card
.... system 1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value 1..1stringCentrelink Customer Reference Number (CRN)
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..*IdentifierMedical Record Number
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding 1..1Coding
...... system 1..1uriFixed Value: http://hl7.org/fhir/v2/0203
...... code 1..1codeFixed Value: MR
..... text 1..1stringFixed Value: Medical Record Number
.... system 1..1uriMedical record number system url
.... value 1..1stringMedical record number value
.... assigner 1..1Reference(Organization)Medical record number assigning entity
... identifier 0..*IdentifierPrivate Health Insurance Member Number
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding 1..1Coding
...... system 1..1uriFixed Value: http://hl7.org/fhir/v2/0203
...... code 1..1codeFixed Value: MB
..... text 1..1stringFixed Value: Private Health Insurance Member Number
.... value 1..1stringPrivate health insurer member number
.... assigner 1..1Reference(Organization)
..... display 1..1string
... patient 1..1Reference(AU Base Patient)Patient record this person relates to
... 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..*A 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)
... 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 ΣIdentifierA human identifier for this person
Slice: Unordered, Open by value:system, value:type
... identifier Σ0..1IdentifierNational Individual Health Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ihi-status 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ihi-status"
..... valueCoding 1..1CodingIHI Number Status Code
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
.... ihi-record-status 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ihi-record-status"
..... valueCoding 1..1CodingIHI Record Status Code
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCoded identifier type for IHI
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..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriRequired system
Fixed Value: http://hl7.org/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: NI
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: IHI
.... system Σ1..1urinational namespace for ihi
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
.... value ΣI1..1stringIndividual Health Identifier number
inv-ihi-0: IHI shall be an exactly 16 digit number
inv-ihi-1: IHI prefix is 800360
inv-ihi-2: IHI shall pass the Luhn algorithm check
Example General': 123456
Example IHI number': 8003608166690503
Max Length: 16
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ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 Σ1..1CodeableConceptDescription of identifier
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..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: MC
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Medicare Number
.... system Σ1..1urinational namespace for medicare
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
.... value Σ1..1stringMedicare Number value including optional individual reference number
Example General': 123456
Example Medicare number': 32788511952
Max Length: 11
.... period Σ1..1PeriodMedicare 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 Expiry Date
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier ΣI0..1IdentifierDVA 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 Σ1..1CodeableConceptDescription of identifier
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 ΣI0..1CodingCode defined by a terminology system
inv-dva-number-coding: DVA colour coding must be DVL, DVW, DVO or DVG
..... text Σ1..1stringPlain text representation of the concept
.... system Σ1..1uriDVA number identifier system
Fixed Value: http://ns.electronichealth.net.au/id/dva
.... value Σ1..1stringDVA number value
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 Σ0..1IdentifierHealth Care Card Identifier
.... 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..1CodeableConceptHealth Care Card Identifier Type
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..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: HC
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Health Care Card Number
.... system Σ1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value Σ1..1stringCentrelink Customer Reference Number (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 Σ0..1IdentifierPensioner Concession Card Identifier
.... 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..1CodeableConceptPensioner Concession Card Identifier Type
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..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: PEN
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Pensioner Concession Card Number
.... system Σ1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value Σ1..1stringCentrelink Customer Reference Number (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 Σ0..1IdentifierCommonwealth Seniors Health Card Identifier
.... 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..1CodeableConceptCommonwealth Seniors Health Card Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"text":"Commonwealth Seniors Health Card"}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: SEN
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Commonwealth Seniors Health Card
.... system Σ1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value Σ1..1stringCentrelink Customer Reference Number (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 Σ0..*IdentifierMedical Record 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..1CodeableConceptDescription of identifier
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 Σ1..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: MR
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Medical Record Number
.... system Σ1..1uriMedical record number system url
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringMedical record number value
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Medical record number assigning entity
... identifier Σ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..1CodeableConceptDescription of identifier
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 Σ1..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: MB
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..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 or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringPrivate health insurer member number
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Organization that issued id (may be just text)
..... 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(AU Base Patient)Patient record this person relates 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