AU Base Implementation Guide
5.0.1-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 5.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Data Type Profile: AU Insurance Member Number

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-insurancemembernumber Version: 5.0.1-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUInsuranceMemberNumber

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This identifier profile defines an insurance member number in an Australian context. An insurance member number is the unique member number assigned to an individual by an insurer and is typically displayed on their insurance card. An individual will not have more than one member number per insurer.

This definition supports the sending of an insurance member number that is relevant in a healthcare context and may be used to capture Australian and International health insurer issued member numbers. In Australia this will typically be a private health insurance member number. This identifier should not be confused with an insurance policy number.

Usage Notes

Usage:

Changes since version 5.0.0:

  • No changes
  • Formal Views of Profile Content

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

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier 0..* Identifier Insurance Member Number
    ... type 1..1 CodeableConcept Description of identifier
    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: MB
    ... system 1..1 uri System identifier namespace for the insurer that assigned the insurance member number
    ... value 1..1 string Insurance member number
    .... display 1..1 string Name of insurer

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier 0..* Identifier Insurance Member Number
    ele-1: All FHIR elements must have a @value or children
    ... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


    ele-1: All FHIR elements must have a @value or children
    ... type Σ 1..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


    ele-1: All FHIR elements must have a @value or children
    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: MB
    ... system Σ 1..1 uri System identifier namespace for the insurer that assigned the insurance member number
    ele-1: All FHIR elements must have a @value or children
    Example General: http://www.acme.com/identifiers/patient
    ... assigner Σ 1..1 Reference(Organization) Insurer
    ele-1: All FHIR elements must have a @value or children
    .... display Σ 1..1 string Name of insurer
    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Identifier.typeextensiblePattern: MB
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier 0..* Identifier Insurance Member Number
    ... id 0..1 string Unique id for inter-element referencing
    ... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ..... version 0..1 string Version of the system - if relevant
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: MB
    ..... display 0..1 string Representation defined by the system
    ..... userSelected 0..1 boolean If this coding was chosen directly by the user
    .... text 0..1 string Plain text representation of the concept
    ... system Σ 1..1 uri System identifier namespace for the insurer that assigned the insurance member number
    Example General: http://www.acme.com/identifiers/patient
    ... value Σ 1..1 string Insurance member number
    Example General: 123456
    ... period Σ 0..1 Period Time period when id is/was valid for use
    ... assigner Σ 1..1 Reference(Organization) Insurer
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
    .... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
    Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

    .... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
    .... display Σ 1..1 string Name of insurer

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Identifier.typeextensiblePattern: MB
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard
    Identifier.assigner.typeextensibleResourceType
    http://hl7.org/fhir/ValueSet/resource-types
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    This structure is derived from Identifier

    Summary

    Mandatory: 5 elements

    Maturity: 2

    Differential View

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier 0..* Identifier Insurance Member Number
    ... type 1..1 CodeableConcept Description of identifier
    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: MB
    ... system 1..1 uri System identifier namespace for the insurer that assigned the insurance member number
    ... value 1..1 string Insurance member number
    .... display 1..1 string Name of insurer

    doco Documentation for this format

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier 0..* Identifier Insurance Member Number
    ele-1: All FHIR elements must have a @value or children
    ... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


    ele-1: All FHIR elements must have a @value or children
    ... type Σ 1..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


    ele-1: All FHIR elements must have a @value or children
    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: MB
    ... system Σ 1..1 uri System identifier namespace for the insurer that assigned the insurance member number
    ele-1: All FHIR elements must have a @value or children
    Example General: http://www.acme.com/identifiers/patient
    ... assigner Σ 1..1 Reference(Organization) Insurer
    ele-1: All FHIR elements must have a @value or children
    .... display Σ 1..1 string Name of insurer
    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Identifier.typeextensiblePattern: MB
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier 0..* Identifier Insurance Member Number
    ... id 0..1 string Unique id for inter-element referencing
    ... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ..... version 0..1 string Version of the system - if relevant
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: MB
    ..... display 0..1 string Representation defined by the system
    ..... userSelected 0..1 boolean If this coding was chosen directly by the user
    .... text 0..1 string Plain text representation of the concept
    ... system Σ 1..1 uri System identifier namespace for the insurer that assigned the insurance member number
    Example General: http://www.acme.com/identifiers/patient
    ... value Σ 1..1 string Insurance member number
    Example General: 123456
    ... period Σ 0..1 Period Time period when id is/was valid for use
    ... assigner Σ 1..1 Reference(Organization) Insurer
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
    .... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
    Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

    .... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
    .... display Σ 1..1 string Name of insurer

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Identifier.typeextensiblePattern: MB
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard
    Identifier.assigner.typeextensibleResourceType
    http://hl7.org/fhir/ValueSet/resource-types
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    This structure is derived from Identifier

    Summary

    Mandatory: 5 elements

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron