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

D.4.1.4 StructureDefinition: - Detailed Descriptions

Definitions for the StructureDefinition-au-relatedperson Profile.

1. RelatedPerson
Definition

Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

Control0..*
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
2. RelatedPerson.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. RelatedPerson.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
4. RelatedPerson.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

5. RelatedPerson.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Max Binding: All Languages
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

6. RelatedPerson.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

7. RelatedPerson.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

8. RelatedPerson.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

9. RelatedPerson.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

10. RelatedPerson.identifier
Definition

Identifier for a person within a particular scope.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

SlicingThis element introduces a set of slices on RelatedPerson.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ type
  • ,
  • value @ system
11. RelatedPerson.identifier:ihiNumber
SliceNameihiNumber
Definition

National Individual Healthcare Identifier (IHI) for the person

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Identifier as assigned and available via Healthcare Identifiers (HI) service

InvariantsDefined on this element
inv-ihi-value-0: IHI shall be an exactly 16 digit number (: value.matches('^([0-9]{16})$'))
inv-ihi-value-1: IHI prefix is 800360 (: value.startsWith('800360'))
inv-ihi-value-2: IHI shall pass the Luhn algorithm check (: (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0))
12. RelatedPerson.identifier:ihiNumber.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
13. RelatedPerson.identifier:ihiNumber.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
14. RelatedPerson.identifier:ihiNumber.extension:ihiStatus
SliceNameihiStatus
Definition

IHI number status associated with an IHI identifier.

Control0..*
TypeExtension(IHIStatusExtension) (Extension Type: Coding)
15. RelatedPerson.identifier:ihiNumber.extension:ihiRecordStatus
SliceNameihiRecordStatus
Definition

Individual Healthcare Identifier (IHI) value record status associated with an IHI identifier

Control0..*
TypeExtension(IHIRecordStatusExtension) (Extension Type: Coding)
16. RelatedPerson.identifier:ihiNumber.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

17. RelatedPerson.identifier:ihiNumber.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingLocal Identifier Type
The codes SHALL be taken from v2 Identifier Type - AU Extended
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/v2/0203"/>
    <code value="NI"/>
  </coding>
</valueCodeableConcept>
18. RelatedPerson.identifier:ihiNumber.type.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
19. RelatedPerson.identifier:ihiNumber.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
20. RelatedPerson.identifier:ihiNumber.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

21. RelatedPerson.identifier:ihiNumber.type.text
Definition

ihi

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Fixed ValueIHI
22. RelatedPerson.identifier:ihiNumber.system
Definition

This namespace is used for qualified identifiers to represent Individual Healthcare Identifier (IHI) numbers. An example of the syntax of an IHI represented as a qualified identifer using this namespace is: http://ns.electronichealth.net.au/id/hi/ihi/1.0/8003600000000000

Control1..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttp://ns.electronichealth.net.au/id/hi/ihi/1.0
Example
General:http://www.acme.com/identifiers/patient
23. RelatedPerson.identifier:ihiNumber.value
Definition

The 16 digit unique identifier for consumers of healthcare services.

Control1..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Max Length16
Example
General:123456
IHI number:8003608833357361
24. RelatedPerson.identifier:ihiNumber.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
25. RelatedPerson.identifier:ihiNumber.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

26. RelatedPerson.identifier:medicareNumber
SliceNamemedicareNumber
Definition

Medicare number assigned to a person. This includes temporary and full Medicare card numbers.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

27. RelatedPerson.identifier:medicareNumber.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
28. RelatedPerson.identifier:medicareNumber.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
29. RelatedPerson.identifier:medicareNumber.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

30. RelatedPerson.identifier:medicareNumber.type
Definition

Medicare number assigned to a person.

Control0..1
BindingLocal Identifier Type
The codes SHALL be taken from v2 Identifier Type - AU Extended
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/v2/0203"/>
    <code value="MC"/>
  </coding>
</valueCodeableConcept>
31. RelatedPerson.identifier:medicareNumber.type.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
32. RelatedPerson.identifier:medicareNumber.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
33. RelatedPerson.identifier:medicareNumber.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

34. RelatedPerson.identifier:medicareNumber.type.text
Definition

Medicare number descriptive text.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Fixed ValueMedicare Number
35. RelatedPerson.identifier:medicareNumber.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttp://ns.electronichealth.net.au/id/medicare-number
Example
General:http://www.acme.com/identifiers/patient
36. RelatedPerson.identifier:medicareNumber.value
Definition

10 digit Medicare number with optional 11th digit individual reference number (IRN)

Control1..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Max Length11
Example
General:123456
Medicare number:32788511952
37. RelatedPerson.identifier:medicareNumber.period
Definition

Time period during which identifier is/was valid for use.

Control1..1
TypePeriod
38. RelatedPerson.identifier:medicareNumber.period.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
39. RelatedPerson.identifier:medicareNumber.period.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.period.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
40. RelatedPerson.identifier:medicareNumber.period.start
Definition

The start of the period. The boundary is inclusive.

Control0..1 This element is affected by the following invariants: per-1
TypedateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

41. RelatedPerson.identifier:medicareNumber.period.end
Definition

Expiry date for Medicare number. This is typically month and year only but may include day date part when this is a temporary Medicare number.

Control1..1 This element is affected by the following invariants: per-1
TypedateTime
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
42. RelatedPerson.identifier:medicareNumber.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

43. RelatedPerson.identifier:dvaNumber
SliceNamedvaNumber
Definition

Department of Veterans' Affairs (DVA) number.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

InvariantsDefined on this element
inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG (: type.coding.code='DVG' and type.text != 'DVA Number (Gold)')
inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL (: type.coding.code='DVL' and type.text != 'DVA Number (Lilac)')
inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO (: type.coding.code='DVO' and type.text != 'DVA Number (Orange)')
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.text = 'DVA Number' or type.text = 'DVA Number (Gold)' or type.text = 'DVA Number (White)' or type.text = 'DVA Number (Orange)' or type.text = 'DVA Number (Lilac)')
inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified (: type.coding.exists() and type.text != 'DVA Number')
inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW (: type.coding.code='DVW' and type.text != 'DVA Number (White)')
44. RelatedPerson.identifier:dvaNumber.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
45. RelatedPerson.identifier:dvaNumber.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
46. RelatedPerson.identifier:dvaNumber.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

47. RelatedPerson.identifier:dvaNumber.type
Definition

Department of Veterans' Affairs (DVA) colour identifer type provides method to determine which type of DVA card is.

Control0..1
BindingLocal Identifier Type
The codes SHALL be taken from v2 Identifier Type - AU Extended
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

48. RelatedPerson.identifier:dvaNumber.type.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
49. RelatedPerson.identifier:dvaNumber.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
50. RelatedPerson.identifier:dvaNumber.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

51. RelatedPerson.identifier:dvaNumber.type.text
Definition

DVA colour coding

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

52. RelatedPerson.identifier:dvaNumber.system
Definition

DVA number assigned uri.

Control1..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttp://ns.electronichealth.net.au/id/dva
Example
General:http://www.acme.com/identifiers/patient
53. RelatedPerson.identifier:dvaNumber.value
Definition

Up to 9 digit value in the form AAXXNNNN[A].

Control1..1
Typestring
Comments

Reference: http://meteor.aihw.gov.au/content/index.phtml/itemId/339127

Max Length9
Example
General:123456
DVA number:NBUR9080
54. RelatedPerson.identifier:dvaNumber.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
55. RelatedPerson.identifier:dvaNumber.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

56. RelatedPerson.identifier:healthcareCard
SliceNamehealthcareCard
Definition

Concession Card Number assigned to a person by Centrelink, this can be Health Card Card, Pensioner Concession Card or Commonwealth Seniors Health Card Number.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

57. RelatedPerson.identifier:healthcareCard.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
58. RelatedPerson.identifier:healthcareCard.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
59. RelatedPerson.identifier:healthcareCard.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

60. RelatedPerson.identifier:healthcareCard.type
Definition

Concession Card Number assigned to a person by Centrelink, this can be Healthcare Card, Pensioner Concession Card or Commonwealth Seniors Health Card Number.

Control1..1
BindingLocal Identifier Type
The codes SHALL be taken from v2 Identifier Type - AU Extended
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/v2/0203"/>
    <code value="HC"/>
  </coding>
</valueCodeableConcept>
61. RelatedPerson.identifier:healthcareCard.type.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
62. RelatedPerson.identifier:healthcareCard.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
63. RelatedPerson.identifier:healthcareCard.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

64. RelatedPerson.identifier:healthcareCard.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Fixed ValueHealth Care Card Number
65. RelatedPerson.identifier:healthcareCard.system
Definition

Namespace for Customer Reference Number (CRN) values

Control1..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttp://ns.electronichealth.net.au/id/centrelink-customer-reference-number
Example
General:http://www.acme.com/identifiers/patient
66. RelatedPerson.identifier:healthcareCard.value
Definition

10 character identifier NNNNNNNNNA.

Control1..1
Typestring
Comments

A personal identifier assigned by Centrelink for the purposes of identifying people (and organisations) eligible for specific services.

Max Length10
Example
General:123456
DHS CRN:307111942H
67. RelatedPerson.identifier:healthcareCard.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
68. RelatedPerson.identifier:healthcareCard.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

69. RelatedPerson.identifier:pensionerConcessionCard
SliceNamepensionerConcessionCard
Definition

Concession Card Number assigned to a person by Centrelink, this can be Health Card Card, Pensioner Concession Card or Commonwealth Seniors Health Card number.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

70. RelatedPerson.identifier:pensionerConcessionCard.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
71. RelatedPerson.identifier:pensionerConcessionCard.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
72. RelatedPerson.identifier:pensionerConcessionCard.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

73. RelatedPerson.identifier:pensionerConcessionCard.type
Definition

Concession card number assigned to a person by Centrelink, this can be Health Care Card, Pensioner Concession Card or Commonwealth Seniors Health Card number

Control1..1
BindingLocal Identifier Type
The codes SHALL be taken from v2 Identifier Type - AU Extended
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/v2/0203"/>
    <code value="PEN"/>
  </coding>
</valueCodeableConcept>
74. RelatedPerson.identifier:pensionerConcessionCard.type.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
75. RelatedPerson.identifier:pensionerConcessionCard.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
76. RelatedPerson.identifier:pensionerConcessionCard.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

77. RelatedPerson.identifier:pensionerConcessionCard.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Fixed ValuePensioner Concession Card Number
78. RelatedPerson.identifier:pensionerConcessionCard.system
Definition

Namespace for Centrelink Customer Reference Number (CRN) values.

Control1..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttp://ns.electronichealth.net.au/id/centrelink-customer-reference-number
Example
General:http://www.acme.com/identifiers/patient
79. RelatedPerson.identifier:pensionerConcessionCard.value
Definition

10 character identifier NNNNNNNNNA

Control1..1
Typestring
Comments

A personal identifier assigned by Centrelink for the purposes of identifying people (and organisations) eligible for specific services.

Max Length10
Example
General:123456
DHS CRN:307111942H
80. RelatedPerson.identifier:pensionerConcessionCard.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
81. RelatedPerson.identifier:pensionerConcessionCard.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

82. RelatedPerson.identifier:commonwealthSeniorsHealthCard
SliceNamecommonwealthSeniorsHealthCard
Definition

Concession Card Number assigned to a person by Centrelink, this can be Health Care Card, Pensioner Concession Card or Commonwealth Seniors Health Card Number

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

83. RelatedPerson.identifier:commonwealthSeniorsHealthCard.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
84. RelatedPerson.identifier:commonwealthSeniorsHealthCard.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
85. RelatedPerson.identifier:commonwealthSeniorsHealthCard.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

86. RelatedPerson.identifier:commonwealthSeniorsHealthCard.type
Definition

Concession Card Number assigned to a person by Centrelink, this can be Health Care Card, Pensioner Concession Card or Commonwealth Seniors Health Card Number

Control1..1
BindingLocal Identifier Type
The codes SHALL be taken from v2 Identifier Type - AU Extended
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org.au/fhir/v2/0203"/>
    <code value="SEN"/>
  </coding>
</valueCodeableConcept>
87. RelatedPerson.identifier:commonwealthSeniorsHealthCard.type.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
88. RelatedPerson.identifier:commonwealthSeniorsHealthCard.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
89. RelatedPerson.identifier:commonwealthSeniorsHealthCard.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

90. RelatedPerson.identifier:commonwealthSeniorsHealthCard.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Fixed ValueCommonwealth Seniors Health Card
91. RelatedPerson.identifier:commonwealthSeniorsHealthCard.system
Definition

Namespace for Centrelink Customer Reference Number (CRN) values.

Control1..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttp://ns.electronichealth.net.au/id/centrelink-customer-reference-number
Example
General:http://www.acme.com/identifiers/patient
92. RelatedPerson.identifier:commonwealthSeniorsHealthCard.value
Definition

10 character identifier NNNNNNNNNA.

Control1..1
Typestring
Comments

A personal identifier assigned by Centrelink for the purposes of identifying people (and organisations) eligible for specific services.

Max Length10
Example
General:123456
DHS CRN:307111942H
93. RelatedPerson.identifier:commonwealthSeniorsHealthCard.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
94. RelatedPerson.identifier:commonwealthSeniorsHealthCard.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

95. RelatedPerson.identifier:medicalRecordNumber
SliceNamemedicalRecordNumber
Definition

An assigned medical record number.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

96. RelatedPerson.identifier:medicalRecordNumber.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
97. RelatedPerson.identifier:medicalRecordNumber.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
98. RelatedPerson.identifier:medicalRecordNumber.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

99. RelatedPerson.identifier:medicalRecordNumber.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control1..1
BindingLocal Identifier Type
The codes SHALL be taken from v2 Identifier Type - AU Extended
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/v2/0203"/>
    <code value="MR"/>
  </coding>
</valueCodeableConcept>
100. RelatedPerson.identifier:medicalRecordNumber.type.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
101. RelatedPerson.identifier:medicalRecordNumber.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
102. RelatedPerson.identifier:medicalRecordNumber.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

103. RelatedPerson.identifier:medicalRecordNumber.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Fixed ValueMedical Record Number
104. RelatedPerson.identifier:medicalRecordNumber.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example
General:http://www.acme.com/identifiers/patient
105. RelatedPerson.identifier:medicalRecordNumber.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
106. RelatedPerson.identifier:medicalRecordNumber.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
107. RelatedPerson.identifier:medicalRecordNumber.assigner
Definition

Organization that issued/manages the identifier.

Control1..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

108. RelatedPerson.identifier:insurerNumber
SliceNameinsurerNumber
Definition

An insurer's member number.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

109. RelatedPerson.identifier:insurerNumber.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
110. RelatedPerson.identifier:insurerNumber.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
111. RelatedPerson.identifier:insurerNumber.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

112. RelatedPerson.identifier:insurerNumber.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control1..1
BindingLocal Identifier Type
The codes SHALL be taken from v2 Identifier Type - AU Extended
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/v2/0203"/>
    <code value="MB"/>
  </coding>
</valueCodeableConcept>
113. RelatedPerson.identifier:insurerNumber.type.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
114. RelatedPerson.identifier:insurerNumber.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
115. RelatedPerson.identifier:insurerNumber.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

116. RelatedPerson.identifier:insurerNumber.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Fixed ValuePrivate Health Insurance Member Number
117. RelatedPerson.identifier:insurerNumber.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control0..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example
General:http://www.acme.com/identifiers/patient
118. RelatedPerson.identifier:insurerNumber.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
119. RelatedPerson.identifier:insurerNumber.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
120. RelatedPerson.identifier:insurerNumber.assigner
Definition

Organization that issued/manages the identifier.

Control1..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

121. RelatedPerson.identifier:insurerNumber.assigner.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
122. RelatedPerson.identifier:insurerNumber.assigner.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on RelatedPerson.identifier.assigner.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
123. RelatedPerson.identifier:insurerNumber.assigner.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control0..1 This element is affected by the following invariants: ref-1
Typestring
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

124. RelatedPerson.identifier:insurerNumber.assigner.identifier
Definition

An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

125. RelatedPerson.identifier:insurerNumber.assigner.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control1..1
Typestring
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

126. RelatedPerson.active
Definition

Whether this related person record is in active use.

Control0..1
Typeboolean
Is Modifiertrue
Requirements

Need to be able to mark a related person record as not to be used, such as if it was created in error.

Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Default Valuetrue
127. RelatedPerson.patient
Definition

The patient this person is related to.

Control1..1
TypeReference(Patient)
Requirements

We need to know which patient this RelatedPerson is related to.

128. RelatedPerson.relationship
Definition

The nature of the relationship between a patient and the related person.

Control0..1
BindingThe codes SHALL be taken from https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

129. RelatedPerson.name
Definition

A name associated with the person.

Control0..*
TypeHumanName
Requirements

Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

130. RelatedPerson.telecom
Definition

A contact detail for the person, e.g. a telephone number or an email address.

Control0..*
TypeContactPoint
Requirements

People have (primary) ways to contact them in some way such as phone, email.

Comments

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

131. RelatedPerson.gender
Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Control0..1
BindingThe gender of a person used for administrative purposes.
The codes SHALL be taken from AdministrativeGender
Typecode
Requirements

Needed for identification of the person, in combination with (at least) name and birth date.

132. RelatedPerson.birthDate
Definition

The date on which the related person was born.

Control0..1
Typedate
133. RelatedPerson.address
Definition

Address where the related person can be contacted or visited.

Control0..*
TypeAddress
Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

134. RelatedPerson.photo
Definition

Image of the person.

Control0..*
TypeAttachment
Requirements

Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.

135. RelatedPerson.period
Definition

The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.

Control0..1
TypePeriod