AU Base Implementation Guide
4.1.0-ballot - CI Build AU

This page is part of AU Base v4.1.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions

Data Type Profile: AU CSP Registration Number

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-cspregistrationnumber Version: 4.1.0-ballot
Draft as of 2022-11-10 Maturity Level: 1 Computable Name: AUCSPRegistrationNumber

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

This identifier profile defines a Contracted Service Provider (CSP)[1] registration number in an Australian context.

A CSP registration number may be issued to organisations who wish to participate in the My Health Record and/or the Healthcare Identifiers Service as a CSP.

Usage:

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 C0..*IdentifierContracted Service Provider (CSP) Registration Number
inv-csp-0: CSP registration number shall be 16 digits
inv-csp-1: CSP registration number prefix shall be 800363
inv-csp-2: CSP registration number shall pass the Luhn algorithm check
... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: CSPRN
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0
... value 1..1stringCSP registration number
Example CSP registration number: 8003639900027009
Max Length: 16

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-csp-0errorIdentifierCSP registration number shall be 16 digits
: value.matches('^([0-9]{16})$')
inv-csp-1errorIdentifierCSP registration number prefix shall be 800363
: value.startsWith('800363')
inv-csp-2errorIdentifierCSP registration number 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)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierContracted Service Provider (CSP) Registration Number
inv-csp-0: CSP registration number shall be 16 digits
inv-csp-1: CSP registration number prefix shall be 800363
inv-csp-2: CSP registration number shall pass the Luhn algorithm check
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: CSPRN
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: CSPRN

Constraints

IdGradePath(s)DetailsRequirements
inv-csp-0errorIdentifierCSP registration number shall be 16 digits
: value.matches('^([0-9]{16})$')
inv-csp-1errorIdentifierCSP registration number prefix shall be 800363
: value.startsWith('800363')
inv-csp-2errorIdentifierCSP registration number 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)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierContracted Service Provider (CSP) Registration Number
inv-csp-0: CSP registration number shall be 16 digits
inv-csp-1: CSP registration number prefix shall be 800363
inv-csp-2: CSP registration number shall pass the Luhn algorithm check
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... id0..1idUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: CSPRN
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0
... value Σ1..1stringCSP registration number
Example General: 123456
Example CSP registration number: 8003639900027009
Max Length: 16
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: CSPRN

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed Value: 1 element

Maturity: 1

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierContracted Service Provider (CSP) Registration Number
inv-csp-0: CSP registration number shall be 16 digits
inv-csp-1: CSP registration number prefix shall be 800363
inv-csp-2: CSP registration number shall pass the Luhn algorithm check
... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: CSPRN
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0
... value 1..1stringCSP registration number
Example CSP registration number: 8003639900027009
Max Length: 16

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-csp-0errorIdentifierCSP registration number shall be 16 digits
: value.matches('^([0-9]{16})$')
inv-csp-1errorIdentifierCSP registration number prefix shall be 800363
: value.startsWith('800363')
inv-csp-2errorIdentifierCSP registration number 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)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierContracted Service Provider (CSP) Registration Number
inv-csp-0: CSP registration number shall be 16 digits
inv-csp-1: CSP registration number prefix shall be 800363
inv-csp-2: CSP registration number shall pass the Luhn algorithm check
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: CSPRN
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: CSPRN

Constraints

IdGradePath(s)DetailsRequirements
inv-csp-0errorIdentifierCSP registration number shall be 16 digits
: value.matches('^([0-9]{16})$')
inv-csp-1errorIdentifierCSP registration number prefix shall be 800363
: value.startsWith('800363')
inv-csp-2errorIdentifierCSP registration number 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)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierContracted Service Provider (CSP) Registration Number
inv-csp-0: CSP registration number shall be 16 digits
inv-csp-1: CSP registration number prefix shall be 800363
inv-csp-2: CSP registration number shall pass the Luhn algorithm check
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... id0..1idUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: CSPRN
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0
... value Σ1..1stringCSP registration number
Example General: 123456
Example CSP registration number: 8003639900027009
Max Length: 16
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: CSPRN

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed Value: 1 element

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron

Notes:

not specified